sphinx-doc / sphinx-argparse

A Sphinx extension to automatically document argparse commands and options
https://sphinx-argparse.readthedocs.org/
MIT License
26 stars 24 forks source link
sphinx sphinx-extension

================= sphinx-argparse

.. image:: https://img.shields.io/pypi/v/sphinx-argparse.svg :target: https://pypi.org/project/sphinx-argparse/ :alt: PyPI version

.. image:: https://img.shields.io/conda/vn/conda-forge/sphinx-argparse.svg :target: https://github.com/conda-forge/sphinx-argparse-feedstock/ :alt: Conda version

.. image:: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml/badge.svg :target: https://github.com/sphinx-doc/sphinx/actions/workflows/main.yml :alt: Build Status

.. image:: https://readthedocs.org/projects/sphinx-argparse/badge/?version=stable :target: https://sphinx-argparse.readthedocs.org/ :alt: Documentation Status

.. image:: https://img.shields.io/badge/License-MIT-blue.svg :target: https://opensource.org/licenses/MIT :alt: MIT

A Sphinx extension to automatically document argparse_ commands and options.

For installation and usage details see the documentation. The changelog is also found there.

.. _argparse: https://docs.python.org/3/library/argparse.html .. _documentation: https://sphinx-argparse.readthedocs.org/ .. _found there: https://sphinx-argparse.readthedocs.org/en/latest/changelog.html

.. note:: This project used to live at alex-rudakov/sphinx-argparse, and has been revived and moved to this new home.

.. _alex-rudakov/sphinx-argparse: https://github.com/alex-rudakov/sphinx-argparse/ .. _new home: https://github.com/sphinx-doc/sphinx-argparse/