tiararodney/psconfluencepublisher
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc(README): add refactor disclaimer

Browse source
This commit is contained in:
Rodney, Tiara 2025-03-16 19:08:41 +01:00
parent 720cb94133
commit 63132830f6
No known key found for this signature in database
GPG key ID: 5CD8EC1D46106723
1 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
README.md
View file

@ -1,7 +1,16 @@
# PSConfluencePublisher # PSConfluencePublisher
> NOTE: Due to the functionality of `xconfluencebuilder` now being part of the
official
[sphinxcontrib-confluencebuilder](https://github.com/sphinx-contrib/confluencebuilder)
project, I am planning on refactoring to support [the official
integration](https://sphinxcontrib-confluencebuilder.readthedocs.io/en/latest/configuration/#confval-confluence_manifest_data).
I wanted to do so anyway, since I want the test suite to both support Pester
v3 and v5, which is a little tricky. The past committer is a pseudonym I've
used, which I will drop for future commits.
This program is a standalone publisher component for the This program is a standalone publisher component for the
[victorykit-xconfluencebuilder](https://bitbucket.org/victorykit/xconfluencebuilder) [victorykit-xconfluencebuilder (DEFUNCT)](https://bitbucket.org/tiaracodes/xconfluencebuilder)
Sphinx extension. Sphinx extension.
It consumes, a JSON-formatted manifest of a *Sphinx build* dump generated by It consumes, a JSON-formatted manifest of a *Sphinx build* dump generated by
@ -39,11 +48,11 @@ PS > Install-Module victorykit.PSConfluencePublisher
Alternatively, you can import the module from source. In order to do that, Alternatively, you can import the module from source. In order to do that,
clone the clone the
[Git repository](https://bitbucket.org/victorykit/psconfluencepublisher/src) [Git repository](https://bitbucket.org/tiaracodes/psconfluencepublisher/src)
, change into the directory and import it. , change into the directory and import it.
``` ```
PS> git clone git@bitbucket.org:victorykit/psconfluencepublisher.git PS> git clone git@bitbucket.org:tiaracodes/psconfluencepublisher.git
``` ```
``` ```