Metadata-Version: 2.1
Name: btd.sphinx.autoprogram
Version: 0.1.6.post1
Summary: Documenting CLI programs
Home-page: https://github.com/buildthedocs/sphinx.autoprogram
Author: Hong Minhee, Patrick Lehmann
Author-email: hong.minhee@gmail.com, Paebbels@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 :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Python :: Implementation :: Stackless
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development :: Documentation
Classifier: Topic :: Utilities
Requires-Dist: Sphinx (>=1.2)
Requires-Dist: six

.. image:: https://img.shields.io/badge/BuildTheDocs-sphinx.autoprogram-323131.svg?logo=github&longCache=true
   :alt: Sourcecode on GitHub
   :height: 22
   :target: https://github.com/buildthedocs/sphinx.autoprogram
.. # change to BSD 2-clause
   image:: https://img.shields.io/badge/Apache%20License,%202.0-bd0000.svg?longCache=true&label=license&logo=Apache&logoColor=D22128
   :alt: License
   :height: 22
.. image:: https://img.shields.io/github/v/tag/buildthedocs/sphinx.autoprogram?logo=GitHub&include_prereleases
   :alt: GitHub tag (latest SemVer incl. pre-release
   :height: 22
   :target: https://github.com/buildthedocs/sphinx.autoprogram/tags
.. image:: https://img.shields.io/github/v/release/buildthedocs/sphinx.autoprogram?logo=GitHub&include_prereleases
   :alt: GitHub release (latest SemVer incl. including pre-releases
   :height: 22
   :target: https://github.com/buildthedocs/sphinx.autoprogram/releases/latest
.. image:: https://img.shields.io/github/release-date/buildthedocs/sphinx.autoprogram?logo=GitHub
   :alt: GitHub release date
   :height: 22
   :target: https://github.com/buildthedocs/sphinx.autoprogram/releases
.. image:: https://img.shields.io/librariesio/release/pypi/btd.sphinx.autoprogram
   :alt: Libraries.io status for latest release
   :height: 22
   :target: https://libraries.io/github/buildthedocs/sphinx.autoprogram
.. # No requirements.txt
   image:: https://img.shields.io/requires/github/buildthedocs/sphinx.autoprogram
   :alt: Requires.io
   :height: 22
   :target: https://requires.io/github/buildthedocs/sphinx.autoprogram/requirements/?branch=master
.. # Replace by GH actions
   image:: https://img.shields.io/travis/com/buildthedocs/autoprogram/buildthedocs/master?logo=Travis
   :alt: Travis - Build on 'master'
   :height: 22
   :target: https://travis-ci.com/buildthedocs/autoprogram
.. image:: https://img.shields.io/pypi/v/btd.sphinx.autoprogram?logo=PyPI
   :alt: PyPI - Tag
   :height: 22
   :target: https://pypi.org/project/sphinx.autoprogram/
.. image:: https://img.shields.io/pypi/status/btd.sphinx.autoprogram?logo=PyPI
   :alt: PyPI - Status
   :height: 22
.. image:: https://img.shields.io/pypi/pyversions/btd.sphinx.autoprogram?logo=PyPI
   :alt: PyPI - Python Version
   :height: 22
.. image:: https://img.shields.io/librariesio/dependent-repos/pypi/btd.sphinx.autoprogram
   :alt: Dependent repos (via libraries.io)
   :height: 22
   :target: https://github.com/buildthedocs/sphinx.autoprogram/network/dependents
.. #
   image:: https://img.shields.io/readthedocs/btd-sphinx-autoprogram
   :alt: Read the Docs
   :height: 22
   :target: https://btd-sphinx-autoprogram.readthedocs.io/en/latest/

``btd.sphinx.autoprogram``
==========================

This is a patched version of `sphinxcontrib.autoprogram <https://github.com/sphinx-contrib/autoprogram>`_ written by Hong Minhee.

--------------------

.. rubric:: Added features

* new option ``label`` to add a label/anchor that can be referenced with ``:ref:``

--------------------

Install using ``pip``:

.. code-block:: console

   $ pip install btd.sphinx.autoprogram


