OmniCLI Sphinx Plugin
A Sphinx extension for automatically documenting omni commands by extracting their help information.
This uses the --output json flag of the help command which was introduced in omni 0.0.29.
Installation
pip install omnicli-sphinx
Usage
- Add 'omnicli_sphinx' to your extensions in conf.py:
extensions = [
'omnicli_sphinx',
# ... other extensions
]
- Use the directive in your RST files:
.. omnicli:: command
Development
Use omni clone omnicli/sphinx-extension to clone this repository.
You can also clone it with git clone and then use omni up to install dependencies.
Use omni test to run the tests.
License
MIT License
1 maintainer
Metadata
1 maintainer
Release files for omnicli-sphinx 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| omnicli_sphinx-0.0.1.tar.gz | 4.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| omnicli_sphinx-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 10.7 kB
Release files / omnicli_sphinx-0.0.1.tar.gz
| Download URL | omnicli_sphinx-0.0.1.tar.gz |
|---|---|
| Size | 4.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
755434b0e3de70e7f56e234c9c390162d77cb14df4a66a5d04bf68fedbb8d817
|
|
BLAKE2b-256 checksum How to use checksums |
ed59ab60c1400d7ebab016aad24969d2bad521e8d50d811d1d520dedb529bea6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 29, 2024.
Transparency logRelease files / omnicli_sphinx-0.0.1-py3-none-any.whl
| Download URL | omnicli_sphinx-0.0.1-py3-none-any.whl |
|---|---|
| Size | 5.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
975e9bf780fff1027e49fd2ee701e8a06a131c951a94fc5b56504ecbdc3ec9e7
|
|
BLAKE2b-256 checksum How to use checksums |
0ca84b06df2bf5a1ba77e0f603a803924cf90230d5ee4d394f93f608363abca9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.1.1 CPython/3.12.7
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 29, 2024.
Transparency log
