https://github.com/sphinx-doc/sphinx-argparse

A Sphinx extension to automatically document argparse commands and options
https://github.com/sphinx-doc/sphinx-argparse

sphinx sphinx-extension

Last synced: about 1 year ago
JSON representation

A Sphinx extension to automatically document argparse commands and options

• Host: GitHub
• URL: https://github.com/sphinx-doc/sphinx-argparse
• Owner: sphinx-doc
• License: mit
• Created: 2021-04-14T13:38:41.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-15T03:07:55.000Z (almost 2 years ago)
• Last Synced: 2025-03-29T00:05:02.543Z (about 1 year ago)
• Topics: sphinx, sphinx-extension
• Language: Python
• Homepage: https://sphinx-argparse.readthedocs.org/
• Size: 428 KB
• Stars: 32
• Watchers: 2
• Forks: 25
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
=================

 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/