索引

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

符号

$.getJSON() ($ 方法)
-a
sphinx-build 命令行选项
-A author
sphinx-apidoc 命令行选项
-A name=value
sphinx-build 命令行选项
-b buildername
sphinx-build 命令行选项
-C
sphinx-build 命令行选项
-c path
sphinx-build 命令行选项
-d maxdepth
sphinx-apidoc 命令行选项
-d path
sphinx-build 命令行选项
-D setting=value
sphinx-build 命令行选项
-E
sphinx-build 命令行选项
-f, --force
sphinx-apidoc 命令行选项
-F, --full
sphinx-apidoc 命令行选项
-H project
sphinx-apidoc 命令行选项
-h, --help, --version
sphinx-build 命令行选项
-l, --follow-links
sphinx-apidoc 命令行选项
-N
sphinx-build 命令行选项
-n
sphinx-build 命令行选项
-n, --dry-run
sphinx-apidoc 命令行选项
-o outputdir
sphinx-apidoc 命令行选项
-P
sphinx-build 命令行选项
-Q
sphinx-build 命令行选项
-q
sphinx-build 命令行选项
-R release
sphinx-apidoc 命令行选项
-s suffix
sphinx-apidoc 命令行选项
-T
sphinx-build 命令行选项
-t tag
sphinx-build 命令行选项
-T, --no-toc
sphinx-apidoc 命令行选项
-v
sphinx-build 命令行选项
-V version
sphinx-apidoc 命令行选项
-W
sphinx-build 命令行选项
-w file
sphinx-build 命令行选项

A

abbr (角色)
accept_comment() (sphinx.websupport.storage.StorageBackend 方法)
add_autodoc_attrgetter() (sphinx.application.Sphinx 方法)
add_autodocumenter() (sphinx.application.Sphinx 方法)
add_builder() (sphinx.application.Sphinx 方法)
add_comment() (sphinx.websupport.storage.StorageBackend 方法)
(sphinx.websupport.WebSupport 方法)
add_config_value() (sphinx.application.Sphinx 方法)
add_crossref_type() (sphinx.application.Sphinx 方法)
add_directive() (sphinx.application.Sphinx 方法)
add_directive_to_domain() (sphinx.application.Sphinx 方法)
add_document() (sphinx.websupport.search.BaseSearch 方法)
add_domain() (sphinx.application.Sphinx 方法)
add_event() (sphinx.application.Sphinx 方法)
add_function_parentheses
configuration value
add_generic_role() (sphinx.application.Sphinx 方法)
add_index_to_domain() (sphinx.application.Sphinx 方法)
add_javascript() (sphinx.application.Sphinx 方法)
add_lexer() (sphinx.application.Sphinx 方法)
add_module_names
configuration value
add_node() (sphinx.application.Sphinx 方法)
(sphinx.websupport.storage.StorageBackend 方法)
add_object_type() (sphinx.application.Sphinx 方法)
add_role() (sphinx.application.Sphinx 方法)
add_role_to_domain() (sphinx.application.Sphinx 方法)
add_search_language() (sphinx.application.Sphinx 方法)
add_stylesheet() (sphinx.application.Sphinx 方法)
add_transform() (sphinx.application.Sphinx 方法)
array<T>::operator[] (C++ 函数)
attributes (內置变量)
autoattribute (指示)
autoclass (指示)
autoclass_content
configuration value
autodata (指示)
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
autoexception (指示)
autofunction (指示)
automatic
documentation
linking
testing
automethod (指示)
automodule (指示)
autosummary (指示)
autosummary_generate
configuration value

B

bar (指示)
BaseSearch (sphinx.websupport.search 中的类)
between() (在 sphinx.ext.autodoc 模块中)
build() (sphinx.builders.Builder 方法)
(sphinx.websupport.WebSupport 方法)
build-finished
event
build_all() (sphinx.builders.Builder 方法)
build_specific() (sphinx.builders.Builder 方法)
build_update() (sphinx.builders.Builder 方法)
Builder (sphinx.builders 中的类)
builder (內置变量)
builder-inited
event

C

c:data (角色)
c:func (角色)
c:function (指示)
c:macro (指示)
(角色)
c:member (指示)
c:type (指示)
(角色)
c:var (指示)
centered (指示)
changes
in version
ChangesBuilder (sphinx.builders.changes 中的类)
CheckExternalLinksBuilder (sphinx.builders.linkcheck 中的类)
class (內置变量)
classes (內置变量)
clear_doc() (sphinx.domains.Domain 方法)
code
examples
codeauthor (指示)
command (角色)
conf (模块)
configuration value
add_function_parentheses
add_module_names
autoclass_content
autodoc_default_flags
autodoc_docstring_signature
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
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_theme
epub_theme_options
epub_title
epub_tocdepth
epub_tocdup
epub_uid
exclude_dirnames
exclude_patterns
exclude_trees
extensions
extlinks
gettext_compact
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_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
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_show_urls
text_newlines
text_sectionchars
today
today_fmt
todo_include_todos
trim_doctest_flags
trim_footnote_reference_space
unused_docs
version
xml_pretty
connect() (sphinx.application.Sphinx 方法)
contents
table of
copyright
configuration value
copyright (內置变量)
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 (sphinx.ext.coverage 中的类)
cpp:class (指示)
(角色)
cpp:func (角色)
cpp:function (指示)
cpp:member (指示)
(角色)
cpp:namespace (指示)
cpp:type (指示)
(角色)
css_files (內置变量)
cut_lines() (在 sphinx.ext.autodoc 模块中)

D

dangling_warnings (sphinx.domains.Domain 属性)
data_version (sphinx.domains.Domain 属性)
DateTime (class)
DateTime::ATOM (class constant)
DateTime::name (class constant)
default
domain
role
default-domain (指示)
default_role
configuration value
delete_comment() (sphinx.websupport.storage.StorageBackend 方法)
deprecated (指示)
describe (指示)
DevhelpBuilder (sphinx.builders.devhelp 中的类)
dfn (角色)
digraph (指示)
directive() (sphinx.domains.Domain 方法)
directives (sphinx.domains.Domain 属性)
DirectoryHTMLBuilder (sphinx.builders.html 中的类)
disconnect() (sphinx.application.Sphinx 方法)
doc (角色)
docstitle (內置变量)
docstring
doctest
(指示)
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
documentation
automatic
Domain (sphinx.domains 中的类)
download (角色)

E

embedded (內置变量)
emit() (sphinx.application.Sphinx 方法)
emit_firstresult() (sphinx.application.Sphinx 方法)
enumerate() (內置函数)
env-get-outdated
event
env-purge-doc
event
env-updated
event
envvar (指示)
(角色)
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_theme
configuration value
epub_theme_options
configuration value
epub_title
configuration value
epub_tocdepth
configuration value
epub_tocdup
configuration value
epub_uid
configuration value
EpubBuilder (sphinx.builders.epub 中的类)
eq (角色)
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 (內置变量)
exclude_dirnames
configuration value
exclude_patterns
configuration value
exclude_trees
configuration value
ExtensionError
extensions
configuration value
extlinks
configuration value
extract_context() (sphinx.websupport.search.BaseSearch 方法)

F

favicon (內置变量)
feed() (sphinx.websupport.search.BaseSearch 方法)
file (角色)
file_suffix (內置变量)
finish() (sphinx.builders.Builder 方法)
finish_indexing() (sphinx.websupport.search.BaseSearch 方法)
foo (C++ 函数)
(指示)
(角色)
fullname (內置变量)
functions (內置变量)

G

generate() (sphinx.domains.Index 方法)
get_data() (sphinx.websupport.storage.StorageBackend 方法)
(sphinx.websupport.WebSupport 方法)
get_document() (sphinx.websupport.WebSupport 方法)
get_objects() (sphinx.domains.Domain 方法)
get_outdated_docs() (sphinx.builders.Builder 方法)
get_relative_uri() (sphinx.builders.Builder 方法)
get_search_results() (sphinx.websupport.WebSupport 方法)
get_target_uri() (sphinx.builders.Builder 方法)
get_type_name() (sphinx.domains.Domain 方法)
gettext_compact
configuration value
global
substitutions
globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder 属性)
glossary (指示)
graph (指示)
graphviz (指示)
graphviz_dot
configuration value
graphviz_dot_args
configuration value
graphviz_output_format
configuration value
guilabel (角色)

H

handle_query() (sphinx.websupport.search.BaseSearch 方法)
has_source (內置变量)
hasdoc() (內置函数)
highlight_language
configuration value
hlist (指示)
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_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 (sphinx.builders.htmlhelp 中的类)

I

ifconfig (指示)
implementation (sphinx.builders.html.SerializingHTMLBuilder 属性)
in version
changes
Index (sphinx.domains 中的类)
index (指示)
(角色)
indices (sphinx.domains.Domain 属性)
inheritance-diagram (指示)
inheritance_edge_attrs
configuration value
inheritance_graph_attrs
configuration value
inheritance_node_attrs
configuration value
init() (sphinx.application.TemplateBridge 方法)
(sphinx.builders.Builder 方法)
init_indexing() (sphinx.websupport.search.BaseSearch 方法)
initial_data (sphinx.domains.Domain 属性)
intersphinx_cache_limit
configuration value
intersphinx_mapping
configuration value

J

js:attr (角色)
js:attribute (指示)
js:class (指示)
(角色)
js:data (指示)
(角色)
js:func (角色)
js:function (指示)
jsmath_path
configuration value
JSONHTMLBuilder (sphinx.builders.html 中的类)

K

kbd (角色)
keep_warnings
configuration value
keyword (角色)

L

label (sphinx.domains.Domain 属性)
language
configuration value
last_updated (內置变量)
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 (sphinx.builders.latex 中的类)
linkcheck_anchors
configuration value
linkcheck_ignore
configuration value
linkcheck_timeout
configuration value
linkcheck_workers
configuration value
linkcode_resolve
configuration value
linking
automatic
literalinclude (指示)
locale_dirs
configuration value
logo (內置变量)

M

mailheader (角色)
makevar (角色)
man_pages
configuration value
man_show_urls
configuration value
manpage (角色)
ManualPageBuilder (sphinx.builders.manpage 中的类)
master_doc
configuration value
master_doc (內置变量)
math (指示)
(角色)
mathjax_path
configuration value
members (內置变量)
menuselection (角色)
merge_domaindata() (sphinx.domains.Domain 方法)
MessageCatalogBuilder (sphinx.builders.gettext 中的类)
meta (內置变量)
methods (內置变量)
mimetype (角色)
missing-reference
event
modindex_common_prefix
configuration value
module (內置变量)
MyAnimal() (类)

N

name (DateTime property)
(sphinx.domains.Domain 属性)
(內置变量)
name() (DateTime 方法)
namespaced::theclass::method (C++ 函数), [1]
needs_sphinx
configuration value
newest_template_mtime() (sphinx.application.TemplateBridge 方法)
newsgroup (角色)
next (內置变量)
nitpick_ignore
configuration value
nitpicky
configuration value
note
(指示)

O

object (指示)
object_types (sphinx.domains.Domain 属性)
objname (內置变量)
ObjType (sphinx.domains 中的类)
only (指示)
operator bool (C++ 函数)
option (指示)
(角色)
out_suffix (sphinx.builders.html.SerializingHTMLBuilder 属性)
override_domain() (sphinx.application.Sphinx 方法)

P

pagename (內置变量)
parents (內置变量)
pathto() (內置函数), [1]
pep (角色)
php:attr (指示)
(角色)
php:class (指示)
(角色)
php:const (指示)
(角色)
php:exc (角色)
php:exception (指示)
php:func (角色)
php:function (指示)
php:global (指示)
(角色)
php:interface (指示)
(角色)
php:meth (角色)
php:method (指示)
php:namespace (指示)
php:ns (角色)
php:staticmethod (指示)
php:trait (指示)
(角色)
PickleHTMLBuilder (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 方法)
pre_build() (sphinx.websupport.storage.StorageBackend 方法)
prepare_writing() (sphinx.builders.Builder 方法)
prev (內置变量)
primary
domain
primary_domain
configuration value
process_doc() (sphinx.domains.Domain 方法)
process_vote() (sphinx.websupport.storage.StorageBackend 方法)
(sphinx.websupport.WebSupport 方法)
productionlist (指示)
program (指示)
(角色)
project
configuration value
project (內置变量)
PseudoXMLBuilder (sphinx.builders.xml 中的类)
py:attr (角色)
py:attribute (指示)
py:class (指示)
(角色)
py:classmethod (指示)
py:const (角色)
py:currentmodule (指示)
py:data (指示)
(角色)
py:decorator (指示)
py:decoratormethod (指示)
py:exc (角色)
py:exception (指示)
py:func (角色)
py:function (指示)
py:meth (角色)
py:method (指示)
py:mod (角色)
py:module (指示)
py:obj (角色)
py:staticmethod (指示)
pygments_style
configuration value

Q

QtHelpBuilder (sphinx.builders.qthelp 中的类)
query() (sphinx.websupport.search.BaseSearch 方法)

R

ref (角色)
regexp (角色)
relbar() (內置函数)
reldelim1 (內置变量)
reldelim2 (內置变量)
release
configuration value
release (內置变量)
rellinks (內置变量)
render() (sphinx.application.TemplateBridge 方法)
render_string() (sphinx.application.TemplateBridge 方法)
require_sphinx() (sphinx.application.Sphinx 方法)
resolve_any_xref() (sphinx.domains.Domain 方法)
resolve_xref() (sphinx.domains.Domain 方法)
rfc (角色)
role() (sphinx.domains.Domain 方法)
roles (sphinx.domains.Domain 属性)
rst:dir (角色)
rst:directive (指示)
rst:role (指示)
(角色)
rst_epilog
configuration value
rst_prolog
configuration value
rubric (指示)

S

samp (角色)
script_files (內置变量)
searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder 属性)
sectionauthor (指示)
seealso (指示)
SerializingHTMLBuilder (sphinx.builders.html 中的类)
setDate() (DateTime 方法)
setTime() (DateTime 方法)
setup_extension() (sphinx.application.Sphinx 方法)
shorttitle (內置变量)
show_authors
configuration value
show_source (內置变量)
sidebar() (內置函数)
SingleFileHTMLBuilder (sphinx.builders.html 中的类)
snippets
testing
source-read
event
source_encoding
configuration value
source_suffix
configuration value
sourcecode
sourcename (內置变量)
sphinx-apidoc 命令行选项
-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 命令行选项
-A name=value
-C
-D setting=value
-E
-N
-P
-Q
-T
-W
-a
-b buildername
-c path
-d path
-h, --help, --version
-n
-q
-t tag
-v
-w file
sphinx.application (模块)
sphinx.builders (模块)
sphinx.builders.changes (模块)
sphinx.builders.devhelp (模块)
sphinx.builders.epub (模块)
sphinx.builders.gettext (模块)
sphinx.builders.html (模块)
sphinx.builders.htmlhelp (模块)
sphinx.builders.latex (模块)
sphinx.builders.linkcheck (模块)
sphinx.builders.manpage (模块)
sphinx.builders.qthelp (模块)
sphinx.builders.texinfo (模块)
sphinx.builders.text (模块)
sphinx.builders.xml (模块)
sphinx.domains (模块)
sphinx.ext.autodoc (模块)
sphinx.ext.autosummary (模块)
sphinx.ext.coverage (模块)
sphinx.ext.doctest (模块)
sphinx.ext.extlinks (模块)
sphinx.ext.graphviz (模块)
sphinx.ext.ifconfig (模块)
sphinx.ext.inheritance_diagram (模块)
sphinx.ext.intersphinx (模块)
sphinx.ext.jsmath (模块)
sphinx.ext.linkcode (模块)
sphinx.ext.mathbase (模块)
sphinx.ext.mathjax (模块)
sphinx.ext.oldcmarkup (模块)
sphinx.ext.pngmath (模块)
sphinx.ext.refcounting (模块)
sphinx.ext.todo (模块)
sphinx.ext.viewcode (模块)
sphinx_version (內置变量)
StandaloneHTMLBuilder (sphinx.builders.html 中的类)
StorageBackend (sphinx.websupport.storage 中的类)
style (內置变量)
substitutions
global

T

table of
contents
tabularcolumns (指示)
template_bridge
configuration value
TemplateBridge (sphinx.application 中的类)
templates_path
configuration value
term (角色)
testcleanup (指示)
testcode (指示)
testing
automatic
snippets
testoutput (指示)
testsetup (指示)
texinfo_appendices
configuration value
texinfo_documents
configuration value
texinfo_domain_indices
configuration value
texinfo_elements
configuration value
texinfo_show_urls
configuration value
TexinfoBuilder (sphinx.builders.texinfo 中的类)
text_newlines
configuration value
text_sectionchars
configuration value
TextBuilder (sphinx.builders.text 中的类)
theclass::const_iterator (C++ 类型)
theclass::name (C++ 成员), [1]
title (內置变量)
toc (內置变量)
toctree (內置变量)
(指示)
today
configuration value
today_fmt
configuration value
todo (指示)
todo_include_todos
configuration value
todolist (指示)
token (角色)
trim_doctest_flags
configuration value
trim_footnote_reference_space
configuration value

U

underline (內置变量)
unused_docs
configuration value
update_username() (sphinx.websupport.storage.StorageBackend 方法)
use_opensearch (內置变量)

V

version
configuration value
version (內置变量)
versionadded (指示)
versionchanged (指示)

W

warning
(指示)
WebSupport (sphinx.websupport 中的类)
write_doc() (sphinx.builders.Builder 方法)

X

xml_pretty
configuration value
XMLBuilder (sphinx.builders.xml 中的类)

符号

主控文档
创建器
指令
文档名
环境
角色
资源目录
配置目录
项目