Sphinx extension to render images of Xournal files.
Usage
You will need to start by installing the extension.
pip install sphinx-xournalYour sphinx conf.py file will need a few changes. To enable this extension it needs to be added to the extensions list.
extensions = [
"sphinx_xournal",
]If xournalpp is not installed in the default location you need to specify one:
xournal_binary_path = "/a/different/place/xournalpp"You are now ready to include your .xopp files in your marvelous documentation.
We provide you with 3 options:
Option 1:
You can generate a restructured image from any Xournal files. This block inherits all the restructured image tags, like :align:.
.. xournal-image:: ./example.xopp
:format: svg
:align: center
Sketch of an example.Option 2:
Same applies for the figure block.
.. xournal-figure:: ./example.xopp
:format: svg
:align: center
Sketch of an example.Option 3 (Experimental):
The last option allows you to embed the raw svg.
.. xournal-raw:: ./example.xopp
:format: svg
:align: center
Sketch of an example.1 maintainer
Metadata
1 maintainer
Release files for sphinx-xournal 0.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 |
|---|---|---|---|---|
| sphinx_xournal-0.1.2.tar.gz | 10.5 kB | Without provenance | Details for sphinx_xournal-0.1.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_xournal-0.1.2-py3-none-any.whl | Python 3 | none | any | Details for sphinx_xournal-0.1.2-py3-none-any.whl |
Total release size: 19.3 kB
Release files / sphinx_xournal-0.1.2.tar.gz
| Download URL | sphinx_xournal-0.1.2.tar.gz |
|---|---|
| Size | 10.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0f42e38acf9cdb91c054eef5bef84d736f1268b2213378837fbe68954211c5da
|
|
BLAKE2b-256 checksum How to use checksums |
9bc971929bee608d734968bad47ba921e817b96b67f9b16a9d2a7b29a86a9b20
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Release files / sphinx_xournal-0.1.2-py3-none-any.whl
| Download URL | sphinx_xournal-0.1.2-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7a36d8efdbb8a45917fc56a735fbfec02aec5930b215837532ee8a8978769d0b
|
|
BLAKE2b-256 checksum How to use checksums |
dba44cf7a4b2f4404601d814b0f0db8c7ffe4f855c8238db2b6f2678fecb4f21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.4
|
Security for sphinx-xournal 0.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.
