sphinx-argparse
sphinx-argparse copied to clipboard
ashb
Sphinx extension that automatically document argparse commands and options
Hi @ashb , do you think you will get to checking out the open pull requests and issues? It's very understandable you don't really want to moderate this project anymore....
https://github.com/ashb/sphinx-argparse/blob/bf1429aa0a4c51ae63d8d6baca0c163a5c6a3a64/sphinxarg/__init__.py#L1C5-L1C5 This is not in sync with the released version of 0.4.0. Perhaps this should be included as part of the release process? Or maybe dynamic version numbers? I don't...
This is a rewrite of https://github.com/alex-rudakov/sphinx-argparse/issues/127 from the old project, but I've made it into a smaller reproducible example. The summary of the issue is that Named Arguments and Options...
Sphinx autodoc_mock_imports is implemented here. https://github.com/ashb/sphinx-argparse/issues/9#issue-1097057823
(this is a necessary duplicate of https://github.com/sphinx-doc/sphinx/issues/11760) The following code produces the following error: ``` .. argparse:: :filename: ../main.py :func: main :prog: main.py ``` ``` Exception occurred: \.venv\Lib\site-packages\sphinxarg\ext.py", line 448,...
So far, shphinxarg only has support for reading/importing Argparse instances from global variables/attributes within a module. However, there are use cases where Argparse is used inside classes of a module,...
Closes #43 This adds the module name and function name (attribute name from the module) to the beginning of the section ID for Named Arguments and options sections. This allows...
I am running Sphinx 4.4.0 with sphinx-argparse 0.3.1 and I am seeing the following warning when using subparsers: ``` /.../api/cli.rst:3: WARNING: duplicate label positional arguments, other instance in /.../api/cli.rst /.../api/cli.rst:3:...
Given an `argparse` that produces an application with the following signature (I leave out the implementation details): ```shell prog --opt command ``` Using this extension, the generated documentation from the...
Output on command line: `-j maximum number of processes to run in parallel` Output in web is missing the ``: `-j` maximum number of processes to run in parallel
