| Name | omnicli-sphinx JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | Sphinx extension for documenting Omni commands |
| upload_time | 2024-11-29 21:19:00 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Raphaël Beamonte <raphael.beamonte@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
cli
documentation
omni
omnicli
sphinx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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
```bash
pip install omnicli-sphinx
```
## Usage
1. Add 'omnicli_sphinx' to your extensions in conf.py:
```python
extensions = [
'omnicli_sphinx',
# ... other extensions
]
```
2. Use the directive in your RST files:
```rst
.. 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
Raw data
{
"_id": null,
"home_page": null,
"name": "omnicli-sphinx",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "cli, documentation, omni, omnicli, sphinx",
"author": null,
"author_email": "Rapha\u00ebl Beamonte <raphael.beamonte@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/ed/59/ab60c1400d7ebab016aad24969d2bad521e8d50d811d1d520dedb529bea6/omnicli_sphinx-0.0.1.tar.gz",
"platform": null,
"description": "# OmniCLI Sphinx Plugin\n\nA Sphinx extension for automatically documenting omni commands by extracting their help information.\n\nThis uses the `--output json` flag of the help command which was introduced in `omni` `0.0.29`.\n\n## Installation\n\n```bash\npip install omnicli-sphinx\n```\n\n## Usage\n\n1. Add 'omnicli_sphinx' to your extensions in conf.py:\n\n```python\nextensions = [\n 'omnicli_sphinx',\n # ... other extensions\n]\n```\n\n2. Use the directive in your RST files:\n\n```rst\n.. omnicli:: command\n```\n\n## Development\n\nUse `omni clone omnicli/sphinx-extension` to clone this repository.\nYou can also clone it with `git clone` and then use `omni up` to install dependencies.\n\nUse `omni test` to run the tests.\n\n## License\n\nMIT License\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Rapha\u00ebl Beamonte <raphael.beamonte@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Sphinx extension for documenting Omni commands",
"version": "0.0.1",
"project_urls": {
"Changelog": "https://github.com/omnicli/sphinx-extension/commits/main/",
"Documentation": "https://omnicli.dev",
"Homepage": "https://omnicli.dev",
"Issues": "https://github.com/omnicli/sphinx-extension/issues",
"Repository": "https://github.com/omnicli/sphinx-extension.git"
},
"split_keywords": [
"cli",
" documentation",
" omni",
" omnicli",
" sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0ca84b06df2bf5a1ba77e0f603a803924cf90230d5ee4d394f93f608363abca9",
"md5": "dc15edbe8eeae048d7e363e0d9390997",
"sha256": "975e9bf780fff1027e49fd2ee701e8a06a131c951a94fc5b56504ecbdc3ec9e7"
},
"downloads": -1,
"filename": "omnicli_sphinx-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dc15edbe8eeae048d7e363e0d9390997",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5895,
"upload_time": "2024-11-29T21:18:45",
"upload_time_iso_8601": "2024-11-29T21:18:45.200113Z",
"url": "https://files.pythonhosted.org/packages/0c/a8/4b06df2bf5a1ba77e0f603a803924cf90230d5ee4d394f93f608363abca9/omnicli_sphinx-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed59ab60c1400d7ebab016aad24969d2bad521e8d50d811d1d520dedb529bea6",
"md5": "47fbd84c6019b99e60c63ae0b5817265",
"sha256": "755434b0e3de70e7f56e234c9c390162d77cb14df4a66a5d04bf68fedbb8d817"
},
"downloads": -1,
"filename": "omnicli_sphinx-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "47fbd84c6019b99e60c63ae0b5817265",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 4761,
"upload_time": "2024-11-29T21:19:00",
"upload_time_iso_8601": "2024-11-29T21:19:00.533278Z",
"url": "https://files.pythonhosted.org/packages/ed/59/ab60c1400d7ebab016aad24969d2bad521e8d50d811d1d520dedb529bea6/omnicli_sphinx-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-29 21:19:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "omnicli",
"github_project": "sphinx-extension",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "omnicli-sphinx"
}
