tiararodney/xconfluencebuilder
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
xconfluencebuilder/samples/default
History
Exact
Rodweil, Theodor b2e0443eaa
chore: remove redundant default sample configuration
2023-08-07 19:22:21 +02:00
..
docs chore: remove redundant default sample configuration 2023-08-07 19:22:21 +02:00
.gitignore feat: init 2023-08-07 01:26:15 +02:00
Pipfile stuff: will squash all of this anyway 2023-08-07 02:15:15 +02:00
Pipfile.lock feat: init 2023-08-07 01:26:15 +02:00
README.md feat: init 2023-08-07 01:26:15 +02:00

README.md

Default Sample

This is a sample/reference implementation of the xconfluencebuilder. It provides a Sphinx build with 2 ancestrally related pages, where the child page contains an attachment.

Output is directed to the build/ directory, which will contain the regular sphinxcontrib.confluencebuilder artifacts in addition to the publishing manifest and referenced assets.

Instructions

To run this reference implementation, you are required to have pipenv installed on your system.

Install the virtual environment by executing the following command from within this directory:

$ python3 -m pipenv install

Afterwards, you can build all assets by issuing the following command

$ python3 -m pipenv run sphinx-build