1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
=================
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/
|
