sphinxcontrib-autoprogram

Documenting CLI programs

2-Clause BSD 10 个版本 Python >=3.8
Hong Minhee <hong.minhee@gmail.com>
主页
Homepage
安装
pip install sphinxcontrib-autoprogram
poetry add sphinxcontrib-autoprogram
pipenv install sphinxcontrib-autoprogram
conda install sphinxcontrib-autoprogram
描述

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/

分类
Development Status :: 5 - Production/Stable Environment :: Console Environment :: Web Environment Framework :: Sphinx :: Extension Intended Audience :: Developers License :: OSI Approved :: BSD License Operating System :: OS Independent Programming Language :: Python Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.8 Programming Language :: Python :: 3.9 Programming Language :: Python :: Implementation :: CPython Programming Language :: Python :: Implementation :: Stackless Topic :: Documentation Topic :: Software Development :: Documentation Topic :: Utilities
版本列表
0.1.9 2024-03-13
0.1.8 2023-02-11
0.1.7 2021-02-10
0.1.5 2018-05-15
0.1.4 2018-02-27
0.1.3 2016-10-06
0.1.2 2015-08-18
0.1.1 2014-04-22
0.1.0 2014-03-02
0.1.9rc1 2024-03-13