Index

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | R | S | T | U | V | W

---

A

abbr role add_autodoc_attrgetter() (sphinx.application.Sphinx method) add_autodocumenter() (sphinx.application.Sphinx method) add_builder() (sphinx.application.Sphinx method) add_config_value() (sphinx.application.Sphinx method) add_crossref_type() (sphinx.application.Sphinx method) add_description_unit() (sphinx.application.Sphinx method) add_directive() (sphinx.application.Sphinx method) add_event() (sphinx.application.Sphinx method) add_function_parentheses configuration value add_generic_role() (sphinx.application.Sphinx method) add_javascript() (sphinx.application.Sphinx method) add_lexer() (sphinx.application.Sphinx method) add_module_names configuration value add_node() (sphinx.application.Sphinx method) add_role() (sphinx.application.Sphinx method) add_transform() (sphinx.application.Sphinx method) attr role attribute directive autoattribute directive autoclass directive

autoclass_content configuration value autodata directive autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_member_order configuration value autoexception directive autofunction directive automatic documentation linking testing automethod directive automodule directive

B

between() (in module sphinx.ext.autodoc) build() (sphinx.builders.Builder method) build-finished event build_all() (sphinx.builders.Builder method) build_specific() (sphinx.builders.Builder method) build_update() (sphinx.builders.Builder method)

builder (built-in variable) Builder (class in sphinx.builders) builder-inited event

C

cdata role centered directive cfunc role cfunction directive changes in version ChangesBuilder (class in sphinx.builders.changes) CheckExternalLinksBuilder (class in sphinx.builders.linkcheck) class directive role classmethod directive cmacro directive role cmdoption directive cmember directive code examples command role conf (module) configuration directory configuration value add_function_parentheses add_module_names autoclass_content autodoc_member_order copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules default_role doctest_global_setup doctest_path doctest_test_doctest_blocks exclude_dirnames exclude_dirs exclude_trees extensions graphviz_dot graphviz_dot_args highlight_language html_add_permalinks html_additional_pages html_copy_source html_favicon html_file_suffix html_last_updated_fmt html_link_suffix html_logo html_short_title html_show_sourcelink html_show_sphinx html_sidebars html_split_index html_static_path html_style html_theme html_theme_options html_theme_path html_title html_translator_class html_use_index html_use_modindex html_use_opensearch html_use_smartypants htmlhelp_basename inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_mapping jsmath_path keep_warnings language latex_additional_files latex_appendices latex_documents latex_elements latex_font_size latex_logo latex_paper_size latex_preamble latex_use_modindex latex_use_parts locale_dirs master_doc modindex_common_prefix pngmath_dvipng pngmath_dvipng_args pngmath_latex pngmath_latex_args pngmath_latex_preamble pngmath_use_preview project pygments_style release rst_epilog show_authors source_encoding source_suffix template_bridge templates_path today today_fmt todo_include_todos trim_footnote_reference_space unused_docs version

connect() (sphinx.application.Sphinx method) const role contents table of copyright configuration value copyright (built-in variable) coverage_c_path configuration value coverage_c_regexes configuration value coverage_ignore_c_items configuration value coverage_ignore_classes configuration value coverage_ignore_functions configuration value coverage_ignore_modules configuration value CoverageBuilder (class in sphinx.ext.coverage) ctype directive role currentmodule directive cut_lines() (in module sphinx.ext.autodoc) cvar directive

D

data directive role default role default_role configuration value describe directive description unit dfn role digraph directive directive attribute autoattribute autoclass autodata autoexception autofunction automethod automodule centered cfunction class classmethod cmacro cmdoption cmember ctype currentmodule cvar data describe digraph doctest envvar exception function glossary graph graphviz hlist ifconfig index inheritance-diagram literalinclude math method module moduleauthor note only productionlist program rubric sectionauthor seealso staticmethod tabularcolumns testcode testoutput testsetup toctree todo todolist versionadded versionchanged warning

DirectoryHTMLBuilder (class in sphinx.builders.html) disconnect() (sphinx.application.Sphinx method) doc role docstitle (built-in variable) docstring doctest directive doctest_global_setup configuration value doctest_path configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event documentation automatic download role

E

embedded (built-in variable) emit() (sphinx.application.Sphinx method) emit_firstresult() (sphinx.application.Sphinx method) env-purge-doc event env-updated event environment envvar directive role eq role event autodoc-process-docstring autodoc-process-signature autodoc-skip-member build-finished builder-inited doctree-read doctree-resolved env-purge-doc env-updated missing-reference page-context source-read

examples code exc role exception directive exclude_dirnames configuration value exclude_dirs configuration value exclude_trees configuration value ExtensionError extensions configuration value

F

favicon (built-in variable) file role file_suffix (built-in variable) finish() (sphinx.builders.Builder method)

func role function directive

G

get_outdated_docs() (sphinx.builders.Builder method) get_relative_uri() (sphinx.builders.Builder method) get_target_uri() (sphinx.builders.Builder method) global substitutions globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder attribute) glossary directive graph directive

graphviz directive graphviz_dot configuration value graphviz_dot_args configuration value guilabel role

H

has_source (built-in variable) hasdoc() (built-in function) highlight_language configuration value hlist directive html_add_permalinks configuration value html_additional_pages configuration value html_copy_source configuration value html_favicon configuration value html_file_suffix configuration value html_last_updated_fmt configuration value html_link_suffix configuration value html_logo configuration value html_short_title configuration value html_show_sourcelink configuration value html_show_sphinx configuration value html_sidebars configuration value

html_split_index configuration value html_static_path configuration value html_style configuration value html_theme configuration value html_theme_options configuration value html_theme_path configuration value html_title configuration value html_translator_class configuration value html_use_index configuration value html_use_modindex configuration value html_use_opensearch configuration value html_use_smartypants configuration value htmlhelp_basename configuration value HTMLHelpBuilder (class in sphinx.builders.html)

I

ifconfig directive implementation (sphinx.builders.html.SerializingHTMLBuilder attribute) in version changes index directive inheritance-diagram directive inheritance_edge_attrs configuration value

inheritance_graph_attrs configuration value inheritance_node_attrs configuration value init() (sphinx.application.TemplateBridge method) (sphinx.builders.Builder method) intersphinx_cache_limit configuration value intersphinx_mapping configuration value

J

jsmath_path configuration value

JSONHTMLBuilder (class in sphinx.builders.html)

K

kbd role keep_warnings configuration value

keyword role

L

language configuration value last_updated (built-in variable) latex_additional_files configuration value latex_appendices configuration value latex_documents configuration value latex_elements configuration value latex_font_size configuration value latex_logo configuration value latex_paper_size configuration value

latex_preamble configuration value latex_use_modindex configuration value latex_use_parts configuration value LaTeXBuilder (class in sphinx.builders.latex) linking automatic literalinclude directive load_env() (sphinx.builders.Builder method) locale_dirs configuration value logo (built-in variable)

M

mailheader role makevar role manpage role master_doc configuration value master_doc (built-in variable) math directive role menuselection role meta (built-in variable) meth role

method directive mimetype role missing-reference event mod role modindex_common_prefix configuration value module directive moduleauthor directive

N

newest_template_mtime() (sphinx.application.TemplateBridge method) newsgroup role next (built-in variable)

note directive

O

obj role only directive

option role out_suffix (sphinx.builders.html.SerializingHTMLBuilder attribute)

P

page-context event pagename (built-in variable) parents (built-in variable) pathto() (built-in function), [1] pep role PickleHTMLBuilder (class in sphinx.builders.html) pngmath_dvipng configuration value pngmath_dvipng_args configuration value pngmath_latex configuration value pngmath_latex_args configuration value pngmath_latex_preamble configuration value

pngmath_use_preview configuration value prepare_writing() (sphinx.builders.Builder method) prev (built-in variable) productionlist directive program directive role project configuration value project (built-in variable) pygments_style configuration value

R

ref role regexp role relbar() (built-in function) reldelim1 (built-in variable) reldelim2 (built-in variable) release configuration value release (built-in variable) rellinks (built-in variable) render() (sphinx.application.TemplateBridge method) render_string() (sphinx.application.TemplateBridge method) rfc role role abbr attr cdata cfunc class cmacro command const ctype data dfn doc download envvar eq exc file func guilabel kbd keyword mailheader makevar manpage math menuselection meth mimetype mod newsgroup obj option pep program ref regexp rfc samp term token

rst_epilog configuration value rubric directive

S

samp role script_files (built-in variable) searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder attribute) sectionauthor directive seealso directive SerializingHTMLBuilder (class in sphinx.builders.html) setup_extension() (sphinx.application.Sphinx method) shorttitle (built-in variable) show_authors configuration value show_source (built-in variable) sidebar() (built-in function) snippets testing source directory source-read event source_encoding configuration value source_suffix configuration value sourcecode sourcename (built-in variable) sphinx.application (module)

sphinx.builders (module) sphinx.builders.changes (module) sphinx.builders.html (module) sphinx.builders.latex (module) sphinx.builders.linkcheck (module) sphinx.builders.text (module) sphinx.ext.autodoc (module) sphinx.ext.autosummary (module) sphinx.ext.coverage (module) sphinx.ext.doctest (module) sphinx.ext.graphviz (module) sphinx.ext.ifconfig (module) sphinx.ext.inheritance_diagram (module) sphinx.ext.intersphinx (module) sphinx.ext.jsmath (module) sphinx.ext.mathbase (module) sphinx.ext.pngmath (module) sphinx.ext.refcounting (module) sphinx.ext.todo (module) sphinx_version (built-in variable) StandaloneHTMLBuilder (class in sphinx.builders.html) staticmethod directive style (built-in variable) substitutions global

T

table of contents tabularcolumns directive template_bridge configuration value TemplateBridge (class in sphinx.application) templates_path configuration value term role testcode directive testing automatic snippets testoutput directive testsetup directive TextBuilder (class in sphinx.builders.text)

title (built-in variable) toc (built-in variable) toctree directive toctree (built-in variable) today configuration value today_fmt configuration value todo directive todo_include_todos configuration value todolist directive token role trim_footnote_reference_space configuration value

U

unused_docs configuration value

use_opensearch (built-in variable)

V

version configuration value version (built-in variable) versionadded directive

versionchanged directive

W

warning directive

write_doc() (sphinx.builders.Builder method)