sphinxcontrib.argdoc
welcome to
sphinxcontrib-argdoc
Introduction
Indices and tables
Quickstart
Installation
Using
sphinxcontrib.argdoc
in your project
Examples
Advanced usage
Preventing
sphinxcontrib-argdoc
from processing one or more, but not all scripts, in a package
Processing a
main-like
function
named something other than
main
Using alternate prefix characters in your
ArgumentParser
Debugging
sphinxcontrib.argdoc
output
Frequently-asked questions
Glossary of terms
Related resources
Projects
Documentation guides
Contributing
Workflow
Formatting
License
The BSD 3-Clause License
Technical documentation
Submodules
sphinxcontrib.argdoc.ext module
User functions
Developer functions
Subpackages
sphinxcontrib.argdoc.test package
Submodules
Subpackages
sphinxcontrib.argdoc
Docs
»
Edit on Bitbucket
Index
_
|
A
|
C
|
D
|
E
|
F
|
G
|
M
|
N
|
P
|
R
|
S
|
T
|
W
_
__init__() (sphinxcontrib.argdoc.test.test_argdoc.FakeApp method)
(sphinxcontrib.argdoc.test.test_argdoc.Record method)
A
argument
C
check_equal() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc static method)
check_list_equal() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc static method)
check_not_match() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc static method)
check_pattern() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc static method)
D
debug() (sphinxcontrib.argdoc.test.test_argdoc.FakeApp method)
debug2() (sphinxcontrib.argdoc.test.test_argdoc.FakeApp method)
docstring
E
emit() (sphinxcontrib.argdoc.test.test_argdoc.FakeApp method)
executable scripts
F
FakeApp (class in sphinxcontrib.argdoc.test.test_argdoc)
format_argparser_as_docstring() (in module sphinxcontrib.argdoc.ext)
format_warning() (in module sphinxcontrib.argdoc.ext)
G
get_col1_text() (in module sphinxcontrib.argdoc.ext)
get_col2_text() (in module sphinxcontrib.argdoc.ext)
get_patterns() (in module sphinxcontrib.argdoc.ext)
get_subcommand_tables() (in module sphinxcontrib.argdoc.ext)
M
main() (in module sphinxcontrib.argdoc.test.cases.c1_argument_group)
(in module sphinxcontrib.argdoc.test.cases.c2_only_subparsers)
(in module sphinxcontrib.argdoc.test.cases.c3_main_plus_subparsers)
(in module sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers)
(in module sphinxcontrib.argdoc.test.cases.c5_with_epilog)
(in module sphinxcontrib.argdoc.test.cases.c6_multiprefix)
(in module sphinxcontrib.argdoc.test.cases.c7_noargdoc)
(in module sphinxcontrib.argdoc.test.cases.c8_exhaustive)
(in module sphinxcontrib.argdoc.test.cases.c9_subsubparsers)
main-like function
make_rest_table() (in module sphinxcontrib.argdoc.ext)
module docstring
N
noargdoc() (in module sphinxcontrib.argdoc.ext)
P
post_process_automodule() (in module sphinxcontrib.argdoc.ext)
R
Record (class in sphinxcontrib.argdoc.test.test_argdoc)
run_builder() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc class method)
S
safeunicode() (in module sphinxcontrib.argdoc.ext)
setup() (in module sphinxcontrib.argdoc)
setUpClass() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc class method)
shell
sphinxcontrib.argdoc (module)
sphinxcontrib.argdoc.ext (module)
sphinxcontrib.argdoc.test (module)
sphinxcontrib.argdoc.test.cases (module)
sphinxcontrib.argdoc.test.cases.c1_argument_group (module)
sphinxcontrib.argdoc.test.cases.c2_only_subparsers (module)
sphinxcontrib.argdoc.test.cases.c3_main_plus_subparsers (module)
sphinxcontrib.argdoc.test.cases.c4_with_long_subparsers (module)
sphinxcontrib.argdoc.test.cases.c5_with_epilog (module)
sphinxcontrib.argdoc.test.cases.c6_multiprefix (module)
sphinxcontrib.argdoc.test.cases.c7_noargdoc (module)
sphinxcontrib.argdoc.test.cases.c8_exhaustive (module)
sphinxcontrib.argdoc.test.cases.c9_subsubparsers (module)
sphinxcontrib.argdoc.test.test_argdoc (module)
T
tearDownClass() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc class method)
test_format_argparser_as_docstring() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_get_col1_text() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_get_col2_text() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_make_rest_table_with_indent() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_make_rest_table_with_title() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_make_rest_table_without_title() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_noargdoc_adds_attribute() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_patterns() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_post_process_automodule() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_post_process_automodule_emits_event() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_prefix_chars_does_not_match_wrong() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_prefix_chars_does_not_mix() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
test_prefix_chars_matches() (sphinxcontrib.argdoc.test.test_argdoc.TestArgdoc method)
TestArgdoc (class in sphinxcontrib.argdoc.test.test_argdoc)
W
warn() (sphinxcontrib.argdoc.test.test_argdoc.FakeApp method)
Read the Docs
v: latest
Versions
latest
Downloads
pdf
htmlzip
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.