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

feat: init

Browse source
This commit is contained in:
Rodweil, Theodor 2023-08-07 01:26:15 +02:00
commit d649185ef6
No known key found for this signature in database
GPG key ID: F8BC1B0EB1F9CCF5
17 changed files with 1493 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

27
samples/default/README.md Normal file
View file

@ -0,0 +1,27 @@
# 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](https://pipenv.pypa.io/en/latest/) 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
```