Metadata-Version: 2.1
Name: sphinxcontrib-autoprogram
Version: 0.1.8
Summary: Documenting CLI programs
Home-page: https://github.com/sphinx-contrib/autoprogram
Author: Hong Minhee
Author-email: hong.minhee@gmail.com
License: 2-Clause BSD
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: Stackless
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.7
License-File: LICENSE

``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/
