Sphinx extension for documenting Omni commands
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
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
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file omnicli_sphinx-0.0.1.tar.gz.
File metadata
- Download URL: omnicli_sphinx-0.0.1.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
755434b0e3de70e7f56e234c9c390162d77cb14df4a66a5d04bf68fedbb8d817
|
|
| MD5 |
47fbd84c6019b99e60c63ae0b5817265
|
|
| BLAKE2b-256 |
ed59ab60c1400d7ebab016aad24969d2bad521e8d50d811d1d520dedb529bea6
|
Provenance
The following attestation bundles were made for omnicli_sphinx-0.0.1.tar.gz:
Publisher:
build.yaml on omnicli/sphinx-extension
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
omnicli_sphinx-0.0.1.tar.gz -
Subject digest:
755434b0e3de70e7f56e234c9c390162d77cb14df4a66a5d04bf68fedbb8d817 - Sigstore transparency entry: 152505099
- Sigstore integration time:
-
Permalink:
omnicli/sphinx-extension@c165419f05960b1aae8a094613222cda313e149d -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/omnicli
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yaml@c165419f05960b1aae8a094613222cda313e149d -
Trigger Event:
push
-
Statement type:
File details
Details for the file omnicli_sphinx-0.0.1-py3-none-any.whl.
File metadata
- Download URL: omnicli_sphinx-0.0.1-py3-none-any.whl
- Upload date:
- Size: 5.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
975e9bf780fff1027e49fd2ee701e8a06a131c951a94fc5b56504ecbdc3ec9e7
|
|
| MD5 |
dc15edbe8eeae048d7e363e0d9390997
|
|
| BLAKE2b-256 |
0ca84b06df2bf5a1ba77e0f603a803924cf90230d5ee4d394f93f608363abca9
|
Provenance
The following attestation bundles were made for omnicli_sphinx-0.0.1-py3-none-any.whl:
Publisher:
build.yaml on omnicli/sphinx-extension
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
omnicli_sphinx-0.0.1-py3-none-any.whl -
Subject digest:
975e9bf780fff1027e49fd2ee701e8a06a131c951a94fc5b56504ecbdc3ec9e7 - Sigstore transparency entry: 152505101
- Sigstore integration time:
-
Permalink:
omnicli/sphinx-extension@c165419f05960b1aae8a094613222cda313e149d -
Branch / Tag:
refs/tags/v0.0.1 - Owner: https://github.com/omnicli
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build.yaml@c165419f05960b1aae8a094613222cda313e149d -
Trigger Event:
push
-
Statement type:
