Index

Symbols

$.getJSON() ($ method) -a sphinx-build command line option -A author sphinx-apidoc command line option -A name=value sphinx-build command line option -b buildername sphinx-build command line option -C sphinx-build command line option -c path sphinx-build command line option -d maxdepth sphinx-apidoc command line option -d path sphinx-build command line option -D setting=value sphinx-build command line option -E sphinx-build command line option -f, --force sphinx-apidoc command line option -F, --full sphinx-apidoc command line option -H project sphinx-apidoc command line option -h, --help, --version sphinx-build command line option -j N sphinx-build command line option -l, --follow-links sphinx-apidoc command line option

-N sphinx-build command line option -n sphinx-build command line option -n, --dry-run sphinx-apidoc command line option -o outputdir sphinx-apidoc command line option -P sphinx-build command line option -Q sphinx-build command line option -q sphinx-build command line option -R release sphinx-apidoc command line option -s suffix sphinx-apidoc command line option -T sphinx-build command line option -t tag sphinx-build command line option -T, --no-toc sphinx-apidoc command line option -v sphinx-build command line option -V version sphinx-apidoc command line option -W sphinx-build command line option -w file sphinx-build command line option

A

abbr (role) abbreviation (class in sphinx.addnodes) accept_comment() (sphinx.websupport.storage.StorageBackend method) add_autodoc_attrgetter() (sphinx.application.Sphinx method) add_autodocumenter() (sphinx.application.Sphinx method) add_builder() (sphinx.application.Sphinx method) add_comment() (sphinx.websupport.storage.StorageBackend method) (sphinx.websupport.WebSupport method) add_config_value() (sphinx.application.Sphinx method) add_crossref_type() (sphinx.application.Sphinx method) add_directive() (sphinx.application.Sphinx method) add_directive_to_domain() (sphinx.application.Sphinx method) add_document() (sphinx.websupport.search.BaseSearch method) add_domain() (sphinx.application.Sphinx method) add_event() (sphinx.application.Sphinx method) add_function_parentheses configuration value add_generic_role() (sphinx.application.Sphinx method) add_index_to_domain() (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) (sphinx.websupport.storage.StorageBackend method) add_object_type() (sphinx.application.Sphinx method) add_role() (sphinx.application.Sphinx method) add_role_to_domain() (sphinx.application.Sphinx method) add_search_language() (sphinx.application.Sphinx method)

add_stylesheet() (sphinx.application.Sphinx method) add_transform() (sphinx.application.Sphinx method) app (sphinx.environment.BuildEnvironment attribute) arguments (docutils.parsers.rst.Directive attribute) array<T>::operator[] (C++ function) attributes (built-in variable) autoattribute (directive) autoclass (directive) autoclass_content configuration value autodata (directive) autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_default_flags configuration value autodoc_docstring_signature configuration value autodoc_member_order configuration value autodoc_mock_imports configuration value autoexception (directive) autofunction (directive) automatic documentation linking testing automethod (directive) automodule (directive) autosummary (directive) autosummary_generate configuration value

B

bar (directive) BaseSearch (class in sphinx.websupport.search) between() (in module sphinx.ext.autodoc) block_text (docutils.parsers.rst.Directive attribute) build() (sphinx.builders.Builder method) (sphinx.websupport.WebSupport method) build-finished event build_all() (sphinx.builders.Builder method)

build_specific() (sphinx.builders.Builder method) build_update() (sphinx.builders.Builder method) BuildEnvironment (class in sphinx.environment) builder (built-in variable) Builder (class in sphinx.builders) builder-inited event

C

c:data (role) c:func (role) c:function (directive) c:macro (directive) (role) c:member (directive) c:type (directive) (role) c:var (directive) category (sphinx.errors.SphinxError attribute) centered (directive) changes in version ChangesBuilder (class in sphinx.builders.changes) CheckExternalLinksBuilder (class in sphinx.builders.linkcheck) class (built-in variable) classes (built-in variable) clear_doc() (sphinx.domains.Domain method) code examples codeauthor (directive) command (role) compact_paragraph (class in sphinx.addnodes) compile() (built-in function) conf (module) Config (class in sphinx.config) config (sphinx.environment.BuildEnvironment attribute) ConfigError configuration directory

configuration value add_function_parentheses add_module_names autoclass_content autodoc_default_flags autodoc_docstring_signature autodoc_member_order autodoc_mock_imports autosummary_generate copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules coverage_skip_undoc_in_source coverage_write_headline default_role doctest_global_cleanup doctest_global_setup doctest_path doctest_test_doctest_blocks epub_author epub_basename epub_copyright epub_cover epub_exclude_files epub_fix_images epub_guide epub_identifier epub_language epub_max_image_width epub_post_files epub_pre_files epub_publisher epub_scheme epub_show_urls epub_theme epub_theme_options epub_title epub_tocdepth epub_tocdup epub_tocscope epub_uid epub_use_index exclude_patterns extensions extlinks gettext_compact gettext_location gettext_uuid graphviz_dot graphviz_dot_args graphviz_output_format highlight_language html_add_permalinks html_additional_pages html_compact_lists html_context html_copy_source html_domain_indices html_extra_path html_favicon html_file_suffix html_last_updated_fmt html_link_suffix html_logo html_output_encoding html_search_language html_search_options html_search_scorer html_secnumber_suffix html_short_title html_show_copyright 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_docclass latex_documents latex_domain_indices latex_elements latex_font_size latex_logo latex_paper_size latex_preamble latex_show_pagerefs latex_show_urls latex_use_modindex latex_use_parts linkcheck_anchors linkcheck_ignore linkcheck_timeout linkcheck_workers linkcode_resolve locale_dirs man_pages man_show_urls master_doc mathjax_path modindex_common_prefix napoleon_google_docstring napoleon_include_private_with_doc napoleon_include_special_with_doc napoleon_numpy_docstring napoleon_use_admonition_for_examples napoleon_use_admonition_for_notes napoleon_use_admonition_for_references napoleon_use_ivar napoleon_use_param napoleon_use_rtype needs_sphinx nitpick_ignore nitpicky pngmath_add_tooltips pngmath_dvipng pngmath_dvipng_args pngmath_latex pngmath_latex_args pngmath_latex_preamble pngmath_use_preview primary_domain project pygments_style release rst_epilog rst_prolog show_authors source_encoding source_suffix template_bridge templates_path texinfo_appendices texinfo_documents texinfo_domain_indices texinfo_elements texinfo_no_detailmenu texinfo_show_urls text_newlines text_sectionchars today today_fmt todo_include_todos trim_doctest_flags trim_footnote_reference_space version xml_pretty connect() (sphinx.application.Sphinx method) content (docutils.parsers.rst.Directive attribute) content_offset (docutils.parsers.rst.Directive attribute) 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 coverage_skip_undoc_in_source configuration value coverage_write_headline configuration value CoverageBuilder (class in sphinx.ext.coverage) cpp:class (directive) (role) cpp:func (role) cpp:function (directive) cpp:member (directive) (role) cpp:namespace (directive) cpp:type (directive) (role) css_files (built-in variable) cut_lines() (in module sphinx.ext.autodoc)

D

dangling_warnings (sphinx.domains.Domain attribute) data_version (sphinx.domains.Domain attribute) debug() (sphinx.application.Sphinx method) debug2() (sphinx.application.Sphinx method) default domain role default-domain (directive) default_role configuration value delete_comment() (sphinx.websupport.storage.StorageBackend method) deprecated (directive) desc (class in sphinx.addnodes) desc_addname (class in sphinx.addnodes) desc_annotation (class in sphinx.addnodes) desc_content (class in sphinx.addnodes) desc_name (class in sphinx.addnodes) desc_optional (class in sphinx.addnodes) desc_parameter (class in sphinx.addnodes) desc_parameterlist (class in sphinx.addnodes) desc_returns (class in sphinx.addnodes) desc_signature (class in sphinx.addnodes) desc_type (class in sphinx.addnodes) describe (directive) DevhelpBuilder (class in sphinx.builders.devhelp) dfn (role) digraph (directive) directive

Directive (class in docutils.parsers.rst) directive() (sphinx.domains.Domain method) directives (sphinx.domains.Domain attribute) DirectoryHTMLBuilder (class in sphinx.builders.html) disconnect() (sphinx.application.Sphinx method) doc (role) doc2path() (sphinx.environment.BuildEnvironment method) docname (sphinx.environment.BuildEnvironment attribute) docstitle (built-in variable) docstring doctest (directive) doctest_global_cleanup configuration value doctest_global_setup configuration value doctest_path configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event doctreedir (sphinx.environment.BuildEnvironment attribute) document name documentation automatic docutils.parsers.rst (module) domain Domain (class in sphinx.domains) download (role) download_reference (class in sphinx.addnodes)

E

embedded (built-in variable) emit() (sphinx.application.Sphinx method) emit_firstresult() (sphinx.application.Sphinx method) enumerate() (built-in function) env-get-outdated event env-purge-doc event env-updated event environment envvar (directive) (role) epub_author configuration value epub_basename configuration value epub_copyright configuration value epub_cover configuration value epub_exclude_files configuration value epub_fix_images configuration value epub_guide configuration value epub_identifier configuration value epub_language configuration value epub_max_image_width configuration value epub_post_files configuration value epub_pre_files configuration value

epub_publisher configuration value epub_scheme configuration value epub_show_urls configuration value epub_theme configuration value epub_theme_options configuration value epub_title configuration value epub_tocdepth configuration value epub_tocdup configuration value epub_tocscope configuration value epub_uid configuration value epub_use_index configuration value EpubBuilder (class in sphinx.builders.epub) eq (role) event autodoc-process-docstring autodoc-process-signature autodoc-skip-member build-finished builder-inited doctree-read doctree-resolved env-get-outdated env-purge-doc env-updated html-collect-pages html-page-context missing-reference source-read examples code exceptions (built-in variable) exclude_patterns configuration value ExtensionError, [1] extensions configuration value extlinks configuration value extract_context() (sphinx.websupport.search.BaseSearch method)

F

favicon (built-in variable) feed() (sphinx.websupport.search.BaseSearch method) file (role) file_suffix (built-in variable) final_argument_whitespace (docutils.parsers.rst.Directive attribute) finish() (sphinx.builders.Builder method)

finish_indexing() (sphinx.websupport.search.BaseSearch method) foo (C++ function) (directive) (role) found_docs (sphinx.environment.BuildEnvironment attribute) fullname (built-in variable) functions (built-in variable)

G

generate() (sphinx.domains.Index method) get_data() (sphinx.websupport.storage.StorageBackend method) (sphinx.websupport.WebSupport method) get_document() (sphinx.websupport.WebSupport method) get_objects() (sphinx.domains.Domain method) get_outdated_docs() (sphinx.builders.Builder method) get_relative_uri() (sphinx.builders.Builder method) get_search_results() (sphinx.websupport.WebSupport method) get_target_uri() (sphinx.builders.Builder method) get_type_name() (sphinx.domains.Domain method) gettext_compact configuration value gettext_location configuration value

gettext_uuid configuration value global substitutions globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder attribute) glossary (class in sphinx.addnodes) (directive) graph (directive) graphviz (directive) graphviz_dot configuration value graphviz_dot_args configuration value graphviz_output_format configuration value guilabel (role)

H

handle_query() (sphinx.websupport.search.BaseSearch method) has_content (docutils.parsers.rst.Directive attribute) has_source (built-in variable) hasdoc() (built-in function) highlight_language configuration value highlightlang (class in sphinx.addnodes) hlist (directive) html-collect-pages event html-page-context event html_add_permalinks configuration value html_additional_pages configuration value html_compact_lists configuration value html_context configuration value html_copy_source configuration value html_domain_indices configuration value html_extra_path 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_output_encoding configuration value html_search_language configuration value

html_search_options configuration value html_search_scorer configuration value html_secnumber_suffix configuration value html_short_title configuration value html_show_copyright 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.htmlhelp)

I

ifconfig (directive) implementation (sphinx.builders.html.SerializingHTMLBuilder attribute) in version changes index (class in sphinx.addnodes) Index (class in sphinx.domains) index (directive) (role) indices (sphinx.domains.Domain attribute) info() (sphinx.application.Sphinx method) 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) init_indexing() (sphinx.websupport.search.BaseSearch method) initial_data (sphinx.domains.Domain attribute) intersphinx_cache_limit configuration value intersphinx_mapping configuration value

J

js:attr (role) js:attribute (directive) js:class (directive) (role) js:data (directive) (role)

js:func (role) js:function (directive) jsmath_path configuration value JSONHTMLBuilder (class in sphinx.builders.html)

K

kbd (role) keep_warnings configuration value

keyword (role)

L

label (sphinx.domains.Domain attribute) language configuration value last_updated (built-in variable) latex_additional_files configuration value latex_appendices configuration value latex_docclass configuration value latex_documents configuration value latex_domain_indices 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_show_pagerefs configuration value latex_show_urls configuration value

latex_use_modindex configuration value latex_use_parts configuration value LaTeXBuilder (class in sphinx.builders.latex) lineno (docutils.parsers.rst.Directive attribute) linkcheck_anchors configuration value linkcheck_ignore configuration value linkcheck_timeout configuration value linkcheck_workers configuration value linkcode_resolve configuration value linking automatic literal_emphasis (class in sphinx.addnodes) literalinclude (directive) locale_dirs configuration value logo (built-in variable)

M

mailheader (role) makevar (role) man_pages configuration value man_show_urls configuration value manpage (role) ManualPageBuilder (class in sphinx.builders.manpage) master document master_doc configuration value master_doc (built-in variable) math (directive) (role) mathjax_path configuration value

members (built-in variable) menuselection (role) MessageCatalogBuilder (class in sphinx.builders.gettext) meta (built-in variable) (class in sphinx.addnodes) metadata (sphinx.environment.BuildEnvironment attribute) methods (built-in variable) mimetype (role) missing-reference event modindex_common_prefix configuration value module (built-in variable) MyAnimal() (class)

N

name (built-in variable) (docutils.parsers.rst.Directive attribute) (sphinx.domains.Domain attribute) namespaced::theclass::method (C++ function), [1] napoleon_google_docstring configuration value napoleon_include_private_with_doc configuration value napoleon_include_special_with_doc configuration value napoleon_numpy_docstring configuration value napoleon_use_admonition_for_examples configuration value napoleon_use_admonition_for_notes configuration value napoleon_use_admonition_for_references configuration value napoleon_use_ivar configuration value napoleon_use_param configuration value

napoleon_use_rtype configuration value needs_sphinx configuration value new_serialno() (sphinx.environment.BuildEnvironment method) newest_template_mtime() (sphinx.application.TemplateBridge method) newsgroup (role) next (built-in variable) nitpick_ignore configuration value nitpicky configuration value note (directive) note_dependency() (sphinx.environment.BuildEnvironment method) note_reread() (sphinx.environment.BuildEnvironment method)

O

object (directive) object_types (sphinx.domains.Domain attribute) objname (built-in variable) ObjType (class in sphinx.domains) only (class in sphinx.addnodes) (directive) operator bool (C++ function)

option (directive) (role) option_spec (docutils.parsers.rst.Directive attribute) optional_arguments (docutils.parsers.rst.Directive attribute) options (docutils.parsers.rst.Directive attribute) out_suffix (sphinx.builders.html.SerializingHTMLBuilder attribute) override_domain() (sphinx.application.Sphinx method)

P

pagename (built-in variable) parents (built-in variable) pathto() (built-in function), [1] pending_xref (class in sphinx.addnodes) pep (role) PickleHTMLBuilder (class in sphinx.builders.html) pngmath_add_tooltips configuration value 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 post_build() (sphinx.websupport.storage.StorageBackend method) pre_build() (sphinx.websupport.storage.StorageBackend method) prepare_writing() (sphinx.builders.Builder method) prev (built-in variable) primary domain primary_domain configuration value process_doc() (sphinx.domains.Domain method) process_vote() (sphinx.websupport.storage.StorageBackend method) (sphinx.websupport.WebSupport method) production (class in sphinx.addnodes) productionlist (class in sphinx.addnodes) (directive) program (directive) (role)

project configuration value project (built-in variable) PseudoXMLBuilder (class in sphinx.builders.xml) py:attr (role) py:attribute (directive) py:class (directive) (role) py:classmethod (directive) py:const (role) py:currentmodule (directive) py:data (directive) (role) py:decorator (directive) py:decoratormethod (directive) py:exc (role) py:exception (directive) py:func (role) py:function (directive) py:meth (role) py:method (directive) py:mod (role) py:module (directive) py:obj (role) py:staticmethod (directive) pygments_style configuration value

Q

QtHelpBuilder (class in sphinx.builders.qthelp)

query() (sphinx.websupport.search.BaseSearch method)

R

ref (role) regexp (role) relbar() (built-in function) reldelim1 (built-in variable) reldelim2 (built-in variable) release configuration value release (built-in variable) relfn2path() (sphinx.environment.BuildEnvironment method) rellinks (built-in variable) render() (sphinx.application.TemplateBridge method) render_string() (sphinx.application.TemplateBridge method) require_sphinx() (sphinx.application.Sphinx method) required_arguments (docutils.parsers.rst.Directive attribute)

resolve_xref() (sphinx.domains.Domain method) rfc (role) role role() (sphinx.domains.Domain method) roles (sphinx.domains.Domain attribute) rst:dir (role) rst:directive (directive) rst:role (directive) (role) rst_epilog configuration value rst_prolog configuration value rubric (directive) run() (docutils.parsers.rst.Directive method)

S

samp (role) script_files (built-in variable) searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder attribute) sectionauthor (directive) seealso (class in sphinx.addnodes) (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) SingleFileHTMLBuilder (class in sphinx.builders.html) snippets testing source directory source-read event source_encoding configuration value source_suffix configuration value sourcecode sourcename (built-in variable) Sphinx (class in sphinx.application) sphinx-apidoc command line option -A author -F, --full -H project -R release -T, --no-toc -V version -d maxdepth -f, --force -l, --follow-links -n, --dry-run -o outputdir -s suffix sphinx-build command line option -A name=value -C -D setting=value -E -N -P -Q -T -W -a -b buildername -c path -d path -h, --help, --version -j N -n -q -t tag -v -w file sphinx.addnodes (module) sphinx.application (module) sphinx.builders (module) sphinx.builders.changes (module) sphinx.builders.devhelp (module) sphinx.builders.epub (module) sphinx.builders.gettext (module) sphinx.builders.html (module) sphinx.builders.htmlhelp (module) sphinx.builders.latex (module) sphinx.builders.linkcheck (module) sphinx.builders.manpage (module) sphinx.builders.qthelp (module) sphinx.builders.texinfo (module)

sphinx.builders.text (module) sphinx.builders.xml (module) sphinx.config (module) sphinx.domains (module) sphinx.environment (module) sphinx.errors (module) sphinx.ext.autodoc (module) sphinx.ext.autosummary (module) sphinx.ext.coverage (module) sphinx.ext.doctest (module) sphinx.ext.extlinks (module) sphinx.ext.graphviz (module) sphinx.ext.ifconfig (module) sphinx.ext.inheritance_diagram (module) sphinx.ext.intersphinx (module) sphinx.ext.jsmath (module) sphinx.ext.linkcode (module) sphinx.ext.mathbase (module) sphinx.ext.mathjax (module) sphinx.ext.napoleon (module) sphinx.ext.pngmath (module) sphinx.ext.todo (module) sphinx.ext.viewcode (module) sphinx_version (built-in variable) SphinxError src (docutils.parsers.rst.Directive attribute) srcdir (sphinx.environment.BuildEnvironment attribute) srcline (docutils.parsers.rst.Directive attribute) StandaloneHTMLBuilder (class in sphinx.builders.html) start_of_file (class in sphinx.addnodes) state (docutils.parsers.rst.Directive attribute) state_machine (docutils.parsers.rst.Directive attribute) StorageBackend (class in sphinx.websupport.storage) 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) termsep (class in sphinx.addnodes) testcleanup (directive) testcode (directive) testing automatic snippets testoutput (directive) testsetup (directive) texinfo_appendices configuration value texinfo_documents configuration value texinfo_domain_indices configuration value texinfo_elements configuration value texinfo_no_detailmenu configuration value texinfo_show_urls configuration value TexinfoBuilder (class in sphinx.builders.texinfo)

text_newlines configuration value text_sectionchars configuration value TextBuilder (class in sphinx.builders.text) theclass::const_iterator (C++ type) theclass::name (C++ member), [1] ThemeError title (built-in variable) titles (sphinx.environment.BuildEnvironment attribute) toc (built-in variable) toctree (built-in variable) (class in sphinx.addnodes) (directive) today configuration value today_fmt configuration value todo (directive) todo_include_todos configuration value todolist (directive) token (role) trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

underline (built-in variable) update_username() (sphinx.websupport.storage.StorageBackend method)

use_opensearch (built-in variable)

V

verbose() (sphinx.application.Sphinx method) version configuration value version (built-in variable) version_info (in module sphinx)

versionadded (directive) versionchanged (directive) versionmodified (class in sphinx.addnodes) VersionRequirementError

W

warn() (sphinx.application.Sphinx method) (sphinx.environment.BuildEnvironment method) warn_node() (sphinx.environment.BuildEnvironment method) warning (directive)

WebSupport (class in sphinx.websupport) write_doc() (sphinx.builders.Builder method)

X

xml_pretty configuration value

XMLBuilder (class in sphinx.builders.xml)