xconfluencebuilder
This program is a drop-in replacement for the Atlassian Confluence Builder for Sphinx. It exports/dumps/archives the build output of the confluencebuilder Sphinx builder into a generic interchangeable format, which can be used in conjunction with other publishers than the built-in one. The program does not require connectivity to a Confluence instance.
The program may be useful in circumstances where a Python3 runtime is not available on the machine responsible for publishing to Confluence.
For more information on why this program exists, please refer to confluencebuilder Issue 823.
For a reference implementation of an external publisher, please refer to PSConfluencePublisher, a standalone PowerShell publisher for Atlassian Confluence Builder for Sphinx.
The following is a sample manifest generated from the default sample:
{
"Pages": [
{
"Title": "Default Sample~",
"Ref": "pages/Default+Sample~.xml"
},
{
"Title": "Cats",
"Ref": "pages/Cats.xml",
"AncestorTitle": "Default Sample~"
}
],
"Attachments": [
{
"Name": "pexels-just-a-couple-photos-3777622.jpg",
"ContainerPageTitle": "Cats",
"MimeType": "image/jpeg",
"Ref": "attachments/Cats/pexels-just-a-couple-photos-3777622.jpg"
},
{
"Name": "pexels-sami-aksu-14356302.jpg",
"ContainerPageTitle": "Cats",
"MimeType": "image/jpeg",
"Ref": "attachments/Cats/pexels-sami-aksu-14356302.jpg"
},
{
"Name": "objects.inv",
"ContainerPageTitle": "Default Sample~",
"MimeType": "application/octet-stream",
"Ref": "attachments/Default+Sample~/objects.inv"
}
]
}
NOTE: The manifest's schema is currently part of the PSConfluencePublisher
Installing
You can install this extension via PyPI (through pip):
python3 -m pip install victorykit-xconfluencebuilder
or via the sources by cloning the repository (then changing into the directory), and also using pip
$ git clone https://bitbucket.org/victorykit/xconfluencebuilder.git
...
$ python3 -m pip install .
Usage
In addition to the basic configuration outlined here, you can find a usage
example under samples/.
- Register the extension sphinxcontrib.confluencebuilder in the project's configuration script (conf.py):
extensions = [
'xconfluencebuilder'
]
- Run sphinx-build with the builder confluence:
sphinx-build -b xconfluence . _build/confluence -E -a
(or)
python -m sphinx -b xconfluence . _build/confluence -E -a
Afterwards, archive the output directory and use it for interchange with an external publisher like the aforementioned PSConfluencePublisher.
More information on the usage of this extension can be obtained from the extension's documentation this is a drop-in for:
Configuration
In addition to the configuration parameters provided by
sphinxcontrib.confluencebuilder, the following parameters are available:
xconfluence_outdir- base directory for archive output (default:{outdir}/confluence.out)xconfluence_manifest_basename- basename of the asset manifest
The following confluencebuilder configuration parameters are not available:
confluence_publish_dry_run(as if set toFalse)
The confluence_publish parameter must still however be set (to True), as
well as all other configuration parameters which would be required for a minimal
configuration of confluencebuilder. Please refer to confluencebuilder
documentation
on how to do so.
Testing
We're patching/mocking a couple of things of the original extension, to make this work. Writing proper unit tests for this would take some time to figure out. We'll discuss this with the original author of the extension.
Issue Tracking
Will be provided shortly.
Metadata
Release files for victorykit-xconfluencebuilder 1.1.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| victorykit-xconfluencebuilder-1.1.2.tar.gz | 4.3 MB | Without provenance | Details for victorykit-xconfluencebuilder-1.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| victorykit_xconfluencebuilder-1.1.2-py3-none-any.whl | Python 3 | none | any | Details for victorykit_xconfluencebuilder-1.1.2-py3-none-any.whl |
Total release size: 4.3 MB
Release files / victorykit-xconfluencebuilder-1.1.2.tar.gz
| Download URL | victorykit-xconfluencebuilder-1.1.2.tar.gz |
|---|---|
| Size | 4.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
35fdcc35a241106224a271309b7a663adb0f4e4d875f6592f6a2e749efcde823
|
|
BLAKE2b-256 checksum How to use checksums |
57bd05ca668255fe4dbab73d1c81d40b2622da00f5f07c27685203ad971367eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / victorykit_xconfluencebuilder-1.1.2-py3-none-any.whl
| Download URL | victorykit_xconfluencebuilder-1.1.2-py3-none-any.whl |
|---|---|
| Size | 8.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7234eec04fc190922737b80af9bce6cef4dc4a99794f883ce6174e2ec37218ce
|
|
BLAKE2b-256 checksum How to use checksums |
468cc3c3483e4ece8bb25a8bc1ff1a994f90490511ede6e8f1e496c123af4951
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for victorykit-xconfluencebuilder 1.1.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.