``sphinxcontrib.autoprogram``
=============================
.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
:target: https://pypi.org/project/sphinxcontrib-autoprogram/
:alt: Latest PyPI version
.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
:target: https://sphinxcontrib-autoprogram.readthedocs.io/
:alt: Documentation Status
.. image:: https://github.com/sphinx-contrib/autoprogram/workflows/Build%20and%20Test/badge.svg?branch=master
:target: https://github.com/sphinx-contrib/autoprogram/actions
:alt: Build Status
This contrib extension, ``sphinxcontrib.autoprogram``, provides an automated
way to document CLI programs. It scans ``argparse.ArgumentParser`` object,
and then expands it into a set of ``.. program::`` and ``.. option::``
directives.
Install using ``pip``:
.. code-block:: console
$ pip install sphinxcontrib-autoprogram
You can find the documentation from the following URL:
https://sphinxcontrib-autoprogram.readthedocs.io/
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-contrib/autoprogram",
"name": "sphinxcontrib-autoprogram",
"maintainer": "",
"docs_url": "https://pythonhosted.org/sphinxcontrib-autoprogram/",
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Hong Minhee",
"author_email": "hong.minhee@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c8/5f/044c87c306c9cbac68a4dccacb18ca0fdd4973096fdd92304ea069b11c59/sphinxcontrib-autoprogram-0.1.9.tar.gz",
"platform": "any",
"description": "``sphinxcontrib.autoprogram``\n=============================\n\n.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg\n :target: https://pypi.org/project/sphinxcontrib-autoprogram/\n :alt: Latest PyPI version\n\n.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/\n :target: https://sphinxcontrib-autoprogram.readthedocs.io/\n :alt: Documentation Status\n\n.. image:: https://github.com/sphinx-contrib/autoprogram/workflows/Build%20and%20Test/badge.svg?branch=master\n :target: https://github.com/sphinx-contrib/autoprogram/actions\n :alt: Build Status\n\nThis contrib extension, ``sphinxcontrib.autoprogram``, provides an automated\nway to document CLI programs. It scans ``argparse.ArgumentParser`` object,\nand then expands it into a set of ``.. program::`` and ``.. option::``\ndirectives.\n\nInstall using ``pip``:\n\n.. code-block:: console\n\n $ pip install sphinxcontrib-autoprogram\n\nYou can find the documentation from the following URL:\n\nhttps://sphinxcontrib-autoprogram.readthedocs.io/\n",
"bugtrack_url": null,
"license": "2-Clause BSD",
"summary": "Documenting CLI programs",
"version": "0.1.9",
"project_urls": {
"Homepage": "https://github.com/sphinx-contrib/autoprogram"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "134c5d9fb7caee7a765c2daf48cdf097c396eef3e1370290589f1b9e30266694",
"md5": "0f6e9b2cae2b29d38c72fc0851d269ca",
"sha256": "79a5282d7640337e4bf11f624970a43709f1b704c5c59a59756d45e824db5301"
},
"downloads": -1,
"filename": "sphinxcontrib_autoprogram-0.1.9-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f6e9b2cae2b29d38c72fc0851d269ca",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 8900,
"upload_time": "2024-03-13T19:10:12",
"upload_time_iso_8601": "2024-03-13T19:10:12.528832Z",
"url": "https://files.pythonhosted.org/packages/13/4c/5d9fb7caee7a765c2daf48cdf097c396eef3e1370290589f1b9e30266694/sphinxcontrib_autoprogram-0.1.9-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c85f044c87c306c9cbac68a4dccacb18ca0fdd4973096fdd92304ea069b11c59",
"md5": "9372d8fe1973789167bee7278561ba54",
"sha256": "219655507fadca29b3062b5d86c37d94db48f03bde4b58d61526872bf72f57cc"
},
"downloads": -1,
"filename": "sphinxcontrib-autoprogram-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "9372d8fe1973789167bee7278561ba54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18843,
"upload_time": "2024-03-13T19:10:14",
"upload_time_iso_8601": "2024-03-13T19:10:14.445428Z",
"url": "https://files.pythonhosted.org/packages/c8/5f/044c87c306c9cbac68a4dccacb18ca0fdd4973096fdd92304ea069b11c59/sphinxcontrib-autoprogram-0.1.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 19:10:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sphinx-contrib",
"github_project": "autoprogram",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinxcontrib-autoprogram"
}
JSON
