All Projects → sphinx-contrib → autoprogram

sphinx-contrib / autoprogram

Licence: other
Documenting CLI programs

Programming Languages

python
139335 projects - #7 most used programming language

Projects that are alternatives of or similar to autoprogram

emojicodes
An extension to use emoji codes in your Sphinx documentation! 😍
Stars: ✭ 39 (+5.41%)
Mutual labels:  sphinxcontrib, sphinx-extension
httpdomain
Documenting RESTful HTTP APIs
Stars: ✭ 51 (+37.84%)
Mutual labels:  sphinxcontrib, sphinx-extension
matlabdomain
A Sphinx extension for documenting Matlab code
Stars: ✭ 34 (-8.11%)
Mutual labels:  sphinxcontrib, sphinx-extension
openapi
OpenAPI (fka Swagger) spec renderer for Sphinx.
Stars: ✭ 78 (+110.81%)
Mutual labels:  sphinx-extension
sphinx-revealjs
Presentation builder for Pythonista
Stars: ✭ 56 (+51.35%)
Mutual labels:  sphinx-extension
cliar
Create modular Python CLIs with type annotations and inheritance
Stars: ✭ 47 (+27.03%)
Mutual labels:  argparse
sphinx-hoverxref
Sphinx extension to show tooltips with content embedded when hover a reference.
Stars: ✭ 77 (+108.11%)
Mutual labels:  sphinx-extension
sphinx-wavedrom
A sphinx extension that allows including wavedrom diagrams by using its text-based representation
Stars: ✭ 26 (-29.73%)
Mutual labels:  sphinx-extension
jsonargparse
Implement minimal boilerplate CLIs derived from type hints and parse from command line, config files and environment variables
Stars: ✭ 168 (+354.05%)
Mutual labels:  argparse
argparseui
automagically add a PyQt based UI to setup options to an argparse based command-line tool
Stars: ✭ 23 (-37.84%)
Mutual labels:  argparse
declarative-parser
Modern, declarative argument parser for Python 3.6+
Stars: ✭ 31 (-16.22%)
Mutual labels:  argparse
sphinx-substitution-extensions
Extensions for Sphinx which allow substitutions
Stars: ✭ 32 (-13.51%)
Mutual labels:  sphinx-extension
docopt-ng
Humane command line arguments parser. Now with maintenance, typehints, and complete test coverage.
Stars: ✭ 94 (+154.05%)
Mutual labels:  argparse
minimist2
TypeScript/JavaScript ES6 rewrite of popular Minimist argument parser
Stars: ✭ 20 (-45.95%)
Mutual labels:  argparse
sphinx-traceability-extension
Traceability extension for Sphinx documentation generator
Stars: ✭ 24 (-35.14%)
Mutual labels:  sphinx-extension
sphinxext-rediraffe
Sphinx extension to redirect files
Stars: ✭ 27 (-27.03%)
Mutual labels:  sphinx-extension
sphinxext-opengraph
Sphinx extension to generate unique OpenGraph metadata
Stars: ✭ 29 (-21.62%)
Mutual labels:  sphinx-extension
YouTube-Tutorials--Italian
📂 Source Code for (some of) the Programming Tutorials from my Italian YouTube Channel and website ProgrammareInPython.it. This is just a small portion of the content: please visit the website for more.
Stars: ✭ 28 (-24.32%)
Mutual labels:  argparse
argparse dataclass
Declarative CLIs with argparse and dataclasses
Stars: ✭ 30 (-18.92%)
Mutual labels:  argparse
sphinxcontrib-django
This is a sphinx extension which improves the documentation of Django apps.
Stars: ✭ 37 (+0%)
Mutual labels:  sphinx-extension

sphinxcontrib.autoprogram

Latest PyPI version Documentation Status 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:

$ pip install sphinxcontrib-autoprogram

You can find the documentation from the following URL:

https://sphinxcontrib-autoprogram.readthedocs.io/

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].