Index

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

Symbols

$.getJSON() ($ method)
-a
command line option
-A name=value
command line option
-b buildername
command line option
-C
command line option
-c path
command line option
-d path
command line option
-D setting=value
command line option
-E
command line option
-N
command line option
-n
command line option
-P
command line option
-Q
command line option
-q
command line option
-t tag
command line option
-W
command line option
-w file
command line option

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_directive() (sphinx.application.Sphinx method)
add_directive_to_domain() (sphinx.application.Sphinx 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)
add_object_type() (sphinx.application.Sphinx method)
add_role() (sphinx.application.Sphinx method)
add_role_to_domain() (sphinx.application.Sphinx method)
add_stylesheet() (sphinx.application.Sphinx method)
add_transform() (sphinx.application.Sphinx method)
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_member_order
configuration value
autoexception (directive)
autofunction (directive)
automatic
documentation
linking
testing
automethod (directive)
automodule (directive)
autosummary (directive)
autosummary_generate
configuration value

B

bar (directive)
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

c:data (role)
c:func (role)
c:function (directive)
c:macro (directive)
(role)
c:member (directive)
c:type (directive)
(role)
c:var (directive)
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)
command line option
-A name=value
-C
-D setting=value
-E
-N
-P
-Q
-W
-a
-b buildername
-c path
-d path
-n
-q
-t tag
-w file
conf (module)
configuration directory
configuration value
add_function_parentheses
add_module_names
autoclass_content
autodoc_default_flags
autodoc_member_order
autosummary_generate
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
epub_author
epub_basename
epub_copyright
epub_exclude_files
epub_identifier
epub_language
epub_post_files
epub_pre_files
epub_publisher
epub_scheme
epub_theme
epub_title
epub_tocdepth
epub_tocdup
epub_uid
exclude_dirnames
exclude_patterns
exclude_trees
extensions
extlinks
graphviz_dot
graphviz_dot_args
graphviz_output_format
highlight_language
html_add_permalinks
html_additional_pages
html_compact_lists
html_copy_source
html_domain_indices
html_favicon
html_file_suffix
html_last_updated_fmt
html_link_suffix
html_logo
html_output_encoding
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
locale_dirs
man_pages
master_doc
modindex_common_prefix
needs_sphinx
nitpicky
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
today
today_fmt
todo_include_todos
trim_doctest_flags
trim_footnote_reference_space
unused_docs
version
connect() (sphinx.application.Sphinx method)
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)
cpp:class (directive)
(role)
cpp:func (role)
cpp:function (directive)
cpp:member (directive)
(role)
cpp:namespace (directive)
cpp:type (directive)
(role)
cut_lines() (in module sphinx.ext.autodoc)

D

dangling_warnings (sphinx.domains.Domain attribute)
data_version (sphinx.domains.Domain attribute)
default
domain
role
default-domain (directive)
default_role
configuration value
describe (directive)
DevhelpBuilder (class in sphinx.builders.devhelp)
dfn (role)
digraph (directive)
directive
directive() (sphinx.domains.Domain method)
directives (sphinx.domains.Domain attribute)
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
document name
documentation
automatic
domain
Domain (class in sphinx.domains)
download (role)

E

embedded (built-in variable)
emit() (sphinx.application.Sphinx method)
emit_firstresult() (sphinx.application.Sphinx method)
enumerate() (built-in function)
env-purge-doc
event
env-updated
event
environment
envvar (directive)
(role)
epub_author
configuration value
epub_basename
configuration value
epub_copyright
configuration value
epub_exclude_files
configuration value
epub_identifier
configuration value
epub_language
configuration value
epub_post_files
configuration value
epub_pre_files
configuration value
epub_publisher
configuration value
epub_scheme
configuration value
epub_theme
configuration value
epub_title
configuration value
epub_tocdepth
configuration value
epub_tocdup
configuration value
epub_uid
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-purge-doc
env-updated
html-collect-pages
html-page-context
missing-reference
source-read
examples
code
exceptions (built-in variable)
exclude_dirnames
configuration value
exclude_patterns
configuration value
exclude_trees
configuration value
ExtensionError
extensions
configuration value
extlinks
configuration value

F

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

G

generate() (sphinx.domains.Index method)
get_objects() (sphinx.domains.Domain method)
get_outdated_docs() (sphinx.builders.Builder method)
get_relative_uri() (sphinx.builders.Builder method)
get_target_uri() (sphinx.builders.Builder method)
get_type_name() (sphinx.domains.Domain 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
graphviz_output_format
configuration value
guilabel (role)

H

has_source (built-in variable)
hasdoc() (built-in function)
highlight_language
configuration value
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_copy_source
configuration value
html_domain_indices
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_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.domains)
index (directive)
indices (sphinx.domains.Domain attribute)
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)
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)
linking
automatic
literalinclude (directive)
locale_dirs
configuration value
logo (built-in variable)

M

mailheader (role)
makevar (role)
man_pages
configuration value
manpage (role)
ManualPageBuilder (class in sphinx.builders.manpage)
master document
master_doc
configuration value
master_doc (built-in variable)
math (directive)
(role)
members (built-in variable)
menuselection (role)
merge_domaindata() (sphinx.domains.Domain method)
meta (built-in variable)
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)
(sphinx.domains.Domain attribute)
namespaced::theclass::method (C++ function), [1]
needs_sphinx
configuration value
newest_template_mtime() (sphinx.application.TemplateBridge method)
newsgroup (role)
next (built-in variable)
nitpicky
configuration value
note
(directive)

O

object
(directive)
object_types (sphinx.domains.Domain attribute)
objname (built-in variable)
ObjType (class in sphinx.domains)
only (directive)
operator bool (C++ function)
option (directive)
(role)
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]
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)
primary
domain
primary_domain
configuration value
process_doc() (sphinx.domains.Domain method)
productionlist (directive)
program (directive)
(role)
project
configuration value
project (built-in variable)
py:attr (role)
py:attribute (directive)
py:class (directive)
(role)
py:classmethod (directive)
py:const (role)
py:currentmodule (directive)
py:data (directive)
(role)
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)

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)
require_sphinx() (sphinx.application.Sphinx method)
resolve_any_xref() (sphinx.domains.Domain method)
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)

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)
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.application (module)
sphinx.builders (module)
sphinx.builders.changes (module)
sphinx.builders.devhelp (module)
sphinx.builders.epub (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.text (module)
sphinx.domains (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.mathbase (module)
sphinx.ext.oldcmarkup (module)
sphinx.ext.pngmath (module)
sphinx.ext.refcounting (module)
sphinx.ext.todo (module)
sphinx.ext.viewcode (module)
sphinx_version (built-in variable)
StandaloneHTMLBuilder (class in sphinx.builders.html)
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)
theclass::const_iterator (C++ type)
theclass::name (C++ member)
title (built-in variable)
toc (built-in variable)
toctree (built-in variable)
(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)
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)