Metadata-Version: 2.1
Name: sphinx-argparse-cli
Version: 1.5.0
Summary: render CLI arguments (sub-commands friendly) defined by argparse module
Home-page: https://github.com/gaborbernat/sphinx-argparse-cli
Author: Bernat Gabor
Author-email: gaborjbernat@gmail.com
Maintainer: Bernat Gabor
Maintainer-email: gaborjbernat@gmail.com
License: MIT
Project-URL: Source, https://github.com/gaborbernat/sphinx-argparse-cli
Project-URL: Tracker, https://github.com/gaborbernat/sphinx-argparse-cli/issues
Project-URL: Documentation, https://github.com/gaborbernat/sphinx-argparse-cli/blob/main/README.md
Description: # sphinx-argparse-cli
        
        [![PyPI](https://img.shields.io/pypi/v/sphinx-argparse-cli?style=flat-square)](https://pypi.org/project/sphinx-argparse-cli)
        [![PyPI - Implementation](https://img.shields.io/pypi/implementation/sphinx-argparse-cli?style=flat-square)](https://pypi.org/project/sphinx-argparse-cli)
        [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/sphinx-argparse-cli?style=flat-square)](https://pypi.org/project/sphinx-argparse-cli)
        [![PyPI - Downloads](https://img.shields.io/pypi/dm/sphinx-argparse-cli?style=flat-square)](https://pypistats.org/packages/sphinx-argparse-cli)
        [![PyPI - License](https://img.shields.io/pypi/l/sphinx-argparse-cli?style=flat-square)](https://opensource.org/licenses/MIT)
        ![check](https://github.com/gaborbernat/sphinx-argparse-cli/workflows/check/badge.svg?branch=main)
        [![Code style:
        black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)
        
        Render CLI arguments (sub-commands friendly) defined by the argparse module. For live demo checkout the documentation of
        [tox](https://tox.readthedocs.io/en/rewrite/cli_interface.html) and
        [mdpo](https://mdpo.readthedocs.io/en/latest/cli.html#command-line-interfaces).
        
        ## installation
        
        ```bash
        python -m pip install sphinx-argparse-cli
        ```
        
        ## enable in your `conf.py`
        
        ```python
        # just add it to your list of extensions to load within conf.py
        extensions = ["sphinx_argparse_cli"]
        ```
        
        ## use
        
        Within the reStructuredText files use the `sphinx_argparse_cli` directive that takes, at least, two arguments:
        
        | Name        | Description                                                                                                                   |
        | ----------- | ----------------------------------------------------------------------------------------------------------------------------- |
        | module      | the module path to where the parser is defined                                                                                |
        | func        | the module path to where the parser is defined                                                                                |
        | prog        | (optional) the module path to where the parser is defined                                                                     |
        | title       | (optional) when provided, overwrites the `<prog> - CLI interface` title added by default and when empty, will not be included |
        | usage_width | (optional) how large should usage examples be - defaults to 100 character                                                     |
        
        For example:
        
        ```rst
        .. sphinx_argparse_cli::
          :module: a_project.cli
          :func: build_parser
          :prog: my-cli-program
        ```
        
Keywords: tox,formatter
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: test
