索引

符号

$.getJSON() ($ 方法) --batchfile, --no-batchfile sphinx-quickstart 命令行选项 --dot=DOT sphinx-quickstart 命令行选项 --ext-autodoc sphinx-quickstart 命令行选项 --ext-coverage sphinx-quickstart 命令行选项 --ext-doctest sphinx-quickstart 命令行选项 --ext-githubpages sphinx-quickstart 命令行选项 --ext-ifconfig sphinx-quickstart 命令行选项 --ext-imgmath sphinx-quickstart 命令行选项 --ext-intersphinx sphinx-quickstart 命令行选项 --ext-mathjax sphinx-quickstart 命令行选项 --ext-todo sphinx-quickstart 命令行选项 --ext-viewcode sphinx-quickstart 命令行选项 --extensions=EXTENSIONS sphinx-quickstart 命令行选项 --implicit-namespaces sphinx-apidoc 命令行选项 --keep-going sphinx-build 命令行选项 --makefile, --no-makefile sphinx-quickstart 命令行选项 --master=MASTER sphinx-quickstart 命令行选项 --sep sphinx-quickstart 命令行选项 --suffix=SUFFIX sphinx-quickstart 命令行选项 --tocfile sphinx-apidoc 命令行选项 --use-make-mode (-m), --no-use-make-mode (-M) sphinx-quickstart 命令行选项 -a sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -A <author> sphinx-apidoc 命令行选项 -a AUTHOR, --author=AUTHOR sphinx-quickstart 命令行选项 -A name=value sphinx-build 命令行选项 -b buildername sphinx-build 命令行选项 -C sphinx-build 命令行选项 -c path sphinx-build 命令行选项 -d <MAXDEPTH> sphinx-apidoc 命令行选项 -d NAME=VALUE sphinx-quickstart 命令行选项 -d path sphinx-build 命令行选项 -D setting=value sphinx-build 命令行选项 -E sphinx-build 命令行选项 -E, --no-headings sphinx-apidoc 命令行选项 -e, --separate sphinx-apidoc 命令行选项

-f, --force sphinx-apidoc 命令行选项 -F, --full sphinx-apidoc 命令行选项 -H <project> sphinx-apidoc 命令行选项 -h, --help, --version sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -i, --imported-members sphinx-autogen 命令行选项 -j N sphinx-build 命令行选项 -l LANGUAGE, --language=LANGUAGE sphinx-quickstart 命令行选项 -l, --follow-links sphinx-apidoc 命令行选项 -M buildername sphinx-build 命令行选项 -M, --module-first sphinx-apidoc 命令行选项 -N sphinx-build 命令行选项 -n sphinx-build 命令行选项 -n, --dry-run sphinx-apidoc 命令行选项 -o <OUTPUT_PATH> sphinx-apidoc 命令行选项 -o <outputdir> sphinx-autogen 命令行选项 -P sphinx-build 命令行选项 -p PROJECT, --project=PROJECT sphinx-quickstart 命令行选项 -P, --private sphinx-apidoc 命令行选项 -Q sphinx-build 命令行选项 -q sphinx-build 命令行选项 -q, --quiet sphinx-quickstart 命令行选项 -R <release> sphinx-apidoc 命令行选项 -r RELEASE, --release=RELEASE sphinx-quickstart 命令行选项 -s <suffix> sphinx-apidoc 命令行选项 -s <suffix>, --suffix <suffix> sphinx-autogen 命令行选项 -T sphinx-build 命令行选项 -t <templates>, --templates <templates> sphinx-autogen 命令行选项 -t tag sphinx-build 命令行选项 -T, --no-toc sphinx-apidoc 命令行选项 -t, --templatedir=TEMPLATEDIR sphinx-quickstart 命令行选项 -v sphinx-build 命令行选项 -V <version> sphinx-apidoc 命令行选项 -v VERSION sphinx-quickstart 命令行选项 -W sphinx-build 命令行选项 -w file sphinx-build 命令行选项

_

_() (在 sphinx.locale 模块中)

__() (在 sphinx.locale 模块中)

A

a (C++ member) abbr (角色) abbreviation (sphinx.addnodes 中的类) accept_comment() (sphinxcontrib.websupport.storage.StorageBackend 方法) add_autodoc_attrgetter() (sphinx.application.Sphinx 方法) add_autodocumenter() (sphinx.application.Sphinx 方法) add_builder() (sphinx.application.Sphinx 方法) add_comment() (sphinxcontrib.websupport.storage.StorageBackend 方法) (sphinxcontrib.websupport.WebSupport 方法) add_config_value() (sphinx.application.Sphinx 方法) add_crossref_type() (sphinx.application.Sphinx 方法) add_css_file() (sphinx.application.Sphinx 方法) add_directive() (sphinx.application.Sphinx 方法), [1] add_directive_to_domain() (sphinx.application.Sphinx 方法), [1] add_document() (sphinxcontrib.websupport.search.BaseSearch 方法) add_domain() (sphinx.application.Sphinx 方法) add_enumerable_node() (sphinx.application.Sphinx 方法) add_env_collector() (sphinx.application.Sphinx 方法) add_event() (sphinx.application.Sphinx 方法) add_function_parentheses configuration value add_generic_role() (sphinx.application.Sphinx 方法) add_html_math_renderer() (sphinx.application.Sphinx 方法) add_html_theme() (sphinx.application.Sphinx 方法) add_index_to_domain() (sphinx.application.Sphinx 方法) add_js_file() (sphinx.application.Sphinx 方法) add_latex_package() (sphinx.application.Sphinx 方法) add_lexer() (sphinx.application.Sphinx 方法) add_message_catalog() (sphinx.application.Sphinx 方法) add_module_names configuration value add_node() (sphinx.application.Sphinx 方法) (sphinxcontrib.websupport.storage.StorageBackend 方法) add_object_type() (sphinx.application.Sphinx 方法) (sphinx.domains.Domain 方法) add_post_transform() (sphinx.application.Sphinx 方法) add_role() (sphinx.application.Sphinx 方法) add_role_to_domain() (sphinx.application.Sphinx 方法) add_search_language() (sphinx.application.Sphinx 方法) add_source_parser() (sphinx.application.Sphinx 方法) add_source_suffix() (sphinx.application.Sphinx 方法) add_transform() (sphinx.application.Sphinx 方法) advance (C++ function) all-files configuration value any (角色) app (sphinx.environment.BuildEnvironment 属性) (sphinx.transforms.SphinxTransform 属性) applehelp_bundle_id configuration value applehelp_bundle_name configuration value applehelp_bundle_version configuration value applehelp_codesign_flags configuration value applehelp_codesign_identity configuration value applehelp_codesign_path configuration value applehelp_dev_region configuration value applehelp_disable_external_tools configuration value applehelp_icon configuration value applehelp_index_anchors configuration value

applehelp_indexer_path configuration value applehelp_kb_product configuration value applehelp_kb_url configuration value applehelp_locale configuration value applehelp_min_term_length configuration value applehelp_remote_url configuration value applehelp_stopwords configuration value applehelp_title configuration value AppleHelpBuilder (sphinxcontrib.applehelp 中的类) apply() (sphinx.transforms.post_transforms.SphinxPostTransform 方法) arguments (docutils.parsers.rst.Directive 属性) attributes (內置变量) author configuration value autoattribute (指令) autobottle (指令) autoclass (指令) autoclass_content configuration value autodata (指令) autodecorator (指令) autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_default_flags configuration value autodoc_default_options configuration value autodoc_docstring_signature configuration value autodoc_inherit_docstrings configuration value autodoc_member_order configuration value autodoc_mock_imports configuration value autodoc_warningiserror configuration value autoexception (指令) autoflask (指令) autofunction (指令) automatic documentation linking testing automethod (指令) automodule (指令) autosectionlabel_maxdepth configuration value autosectionlabel_prefix_document configuration value autosummary (指令) autosummary_generate configuration value autosummary_mock_imports configuration value autotornado (指令)

B

bar (指令) BaseSearch (sphinxcontrib.websupport.search 中的类) between() (在 sphinx.ext.autodoc 模块中) block_text (docutils.parsers.rst.Directive 属性) body (內置变量) build() (sphinx.builders.Builder 方法) (sphinxcontrib.websupport.WebSupport 方法) build-dir configuration value build-finished event

build_all() (sphinx.builders.Builder 方法) build_specific() (sphinx.builders.Builder 方法) build_update() (sphinx.builders.Builder 方法) BuildEnvironment (sphinx.environment 中的类) builder configuration value Builder (sphinx.builders 中的类) builder (內置变量) builder-inited event

C

c:data (角色) c:func (角色) c:function (指令) c:macro (指令) (角色) c:member (指令) (角色) c:type (指令) (角色) c:var (指令) category (sphinx.errors.SphinxError 属性) centered (指令) changes in version ChangesBuilder (sphinx.builders.changes 中的类) check_consistency() (sphinx.domains.Domain 方法) CheckExternalLinksBuilder (sphinx.builders.linkcheck 中的类) class (內置变量) classes (內置变量) clear_doc() (sphinx.domains.Domain 方法) (sphinx.environment.collectors.EnvironmentCollector 方法) code examples code-block (指令) codeauthor (指令) command (角色) compact_paragraph (sphinx.addnodes 中的类) compile() (內置函数) conf (模块) confdir (sphinx.application.Sphinx 属性) Config (sphinx.config 中的类) config (sphinx.environment.BuildEnvironment 属性) (sphinx.transforms.SphinxTransform 属性) (sphinx.util.docutils.SphinxDirective 属性) (sphinx.util.docutils.SphinxRole 属性) config-dir configuration value config-inited event ConfigError configuration value add_function_parentheses add_module_names all-files applehelp_bundle_id applehelp_bundle_name applehelp_bundle_version applehelp_codesign_flags applehelp_codesign_identity applehelp_codesign_path applehelp_dev_region applehelp_disable_external_tools applehelp_icon applehelp_index_anchors applehelp_indexer_path applehelp_kb_product applehelp_kb_url applehelp_locale applehelp_min_term_length applehelp_remote_url applehelp_stopwords applehelp_title author autoclass_content autodoc_default_flags autodoc_default_options autodoc_docstring_signature autodoc_inherit_docstrings autodoc_member_order autodoc_mock_imports autodoc_warningiserror autosectionlabel_maxdepth autosectionlabel_prefix_document autosummary_generate autosummary_mock_imports build-dir builder config-dir copyright, [1] 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 cpp_id_attributes cpp_index_common_prefix cpp_paren_attributes default_role doctest_default_flags doctest_global_cleanup doctest_global_setup doctest_path doctest_test_doctest_blocks epub_author epub_basename epub_contributor epub_copyright epub_cover epub_css_files epub_description 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 epub_writing_mode exclude_patterns extensions extlinks figure_language_filename fresh-env gettext_additional_targets gettext_auto_build gettext_compact gettext_location gettext_uuid graphviz_dot graphviz_dot_args graphviz_output_format highlight_language highlight_options html4_writer html_add_permalinks html_additional_pages html_baseurl html_compact_lists html_context html_copy_source html_css_files html_domain_indices html_experimental_html5_writer html_extra_path html_favicon html_file_suffix html_js_files html_last_updated_fmt html_link_suffix html_logo html_math_renderer html_output_encoding html_scaled_image_link 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_sourcelink_suffix html_split_index html_static_path html_style html_theme html_theme_options html_theme_path html_title html_use_index html_use_opensearch html_use_smartypants htmlhelp_basename htmlhelp_file_suffix htmlhelp_link_suffix image_converter image_converter_args imgmath_add_tooltips imgmath_dvipng imgmath_dvipng_args imgmath_dvisvgm imgmath_dvisvgm_args imgmath_font_size imgmath_image_format imgmath_latex imgmath_latex_args imgmath_latex_preamble imgmath_use_preview inheritance_alias inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_mapping intersphinx_timeout jsmath_path keep_warnings language latex_additional_files latex_appendices latex_docclass latex_documents latex_domain_indices latex_elements latex_engine latex_logo latex_show_pagerefs latex_show_urls latex_toplevel_sectioning latex_use_latex_multicolumn latex_use_xindy link-index linkcheck_anchors linkcheck_anchors_ignore linkcheck_ignore linkcheck_retries linkcheck_timeout linkcheck_workers linkcode_resolve locale_dirs man_pages man_show_urls manpages_url master_doc math_eqref_format math_number_all math_numfig mathjax_config mathjax_options mathjax_path modindex_common_prefix napoleon_google_docstring napoleon_include_init_with_doc 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_keyword napoleon_use_param napoleon_use_rtype needs_extensions needs_sphinx nitpick_ignore nitpicky, [1] numfig numfig_format numfig_secnum_depth pdb primary_domain project, [1] pygments_style qthelp_basename qthelp_namespace qthelp_theme qthelp_theme_options release, [1] rst_epilog rst_prolog show_authors singlehtml_sidebars smartquotes smartquotes_action smartquotes_excludes source-dir source_encoding source_parsers source_suffix suppress_warnings template_bridge templates_path texinfo_appendices texinfo_documents texinfo_domain_indices texinfo_elements texinfo_no_detailmenu texinfo_show_urls text_add_secnumbers text_newlines text_secnumber_suffix text_sectionchars tls_cacerts tls_verify today, [1] today_fmt todo_emit_warnings todo_include_todos todo_link_only trim_doctest_flags trim_footnote_reference_space version, [1] viewcode_enable_epub viewcode_follow_imported_members warning-is-error xml_pretty

connect() (sphinx.application.Sphinx 方法) content (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性) content_offset (docutils.parsers.rst.Directive 属性) contents table of conversion_rules (sphinx.transforms.post_transforms.images.ImageConverter 属性) convert() (sphinx.transforms.post_transforms.images.ImageConverter 方法) copyright configuration value, [1] 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:alias (指令) cpp:any (角色) cpp:class (指令) (角色) cpp:concept (指令) (角色) cpp:enum (指令) (角色) cpp:enum-class (指令) cpp:enum-struct (指令) cpp:enumerator (指令) (角色) cpp:expr (角色) cpp:func (角色) cpp:function (指令) cpp:member (指令) (角色) cpp:namespace (指令) cpp:namespace-pop (指令) cpp:namespace-push (指令) cpp:struct (指令) (角色) cpp:texpr (角色) cpp:type (指令) (角色) cpp:union (指令) cpp:var (指令) (角色) cpp_id_attributes configuration value cpp_index_common_prefix configuration value cpp_paren_attributes configuration value critical() (sphinx.util.logging.SphinxLoggerAdapter 方法) cut_lines() (在 sphinx.ext.autodoc 模块中)

D

dangling_warnings (sphinx.domains.Domain 属性) Data (C++ class) data (sphinx.domains.Domain 属性) Data::[anonymous] (C++ union) Data::[anonymous]::a (C++ member) Data::[anonymous]::b (C++ member) data_version (sphinx.domains.Domain 属性) debug() (sphinx.util.logging.SphinxLoggerAdapter 方法) default domain role default-domain (指令) default_role configuration value default_translator_class (sphinx.builders.Builder 属性) delete_comment() (sphinxcontrib.websupport.storage.StorageBackend 方法) deprecated (指令) desc (sphinx.addnodes 中的类) desc_addname (sphinx.addnodes 中的类) desc_annotation (sphinx.addnodes 中的类) desc_content (sphinx.addnodes 中的类) desc_name (sphinx.addnodes 中的类) desc_optional (sphinx.addnodes 中的类) desc_parameter (sphinx.addnodes 中的类) desc_parameterlist (sphinx.addnodes 中的类) desc_returns (sphinx.addnodes 中的类) desc_signature (sphinx.addnodes 中的类) desc_signature_line (sphinx.addnodes 中的类) desc_type (sphinx.addnodes 中的类) describe (指令) DevhelpBuilder (sphinxcontrib.devhelp 中的类) dfn (角色) digraph (指令) Directive (docutils.parsers.rst 中的类) directive() (sphinx.domains.Domain 方法) directives (sphinx.domains.Domain 属性)

DirectoryHTMLBuilder (sphinx.builders.dirhtml 中的类) disconnect() (sphinx.application.Sphinx 方法) discover() (sphinx.project.Project 方法) display_toc (內置变量) doc (角色) doc2path() (sphinx.environment.BuildEnvironment 方法) (sphinx.project.Project 方法) docname (sphinx.environment.BuildEnvironment 属性) docnames (sphinx.project.Project 属性) docstitle (內置变量) docstring doctest (指令) doctest_default_flags configuration value 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.application.Sphinx 属性) (sphinx.environment.BuildEnvironment 属性) documentation automatic docutils.parsers.rst (模块) Domain (sphinx.domains 中的类) download (角色) download_reference (sphinx.addnodes 中的类) DummyBuilder (sphinx.builders.dummy 中的类)

E

embedded (內置变量) emit() (sphinx.application.Sphinx 方法) emit_firstresult() (sphinx.application.Sphinx 方法) enumerable_nodes (sphinx.domains.Domain 属性) enumerate() (內置函数) env (sphinx.transforms.SphinxTransform 属性) (sphinx.util.docutils.SphinxDirective 属性) (sphinx.util.docutils.SphinxRole 属性) env-before-read-docs event env-check-consistency event env-get-outdated event env-merge-info event env-purge-doc event env-updated event EnvironmentCollector (sphinx.environment.collectors 中的类) envvar (指令) (角色) epilog (sphinx.builders.Builder 属性) Epub3Builder (sphinx.builders.epub3 中的类) epub_author configuration value epub_basename configuration value epub_contributor configuration value epub_copyright configuration value epub_cover configuration value epub_css_files configuration value epub_description 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 epub_writing_mode configuration value eq (角色) error() (sphinx.util.logging.SphinxLoggerAdapter 方法) escape() (內置函数) event autodoc-process-docstring autodoc-process-signature autodoc-skip-member build-finished builder-inited config-inited doctree-read doctree-resolved env-before-read-docs env-check-consistency env-get-outdated env-merge-info env-purge-doc env-updated html-collect-pages html-page-context missing-reference source-read todo-defined viewcode-find-source viewcode-follow-imported examples code exceptions (內置变量) exclude_patterns configuration value ExtensionError, [1] extensions configuration value extlinks configuration value extract_context() (sphinxcontrib.websupport.search.BaseSearch 方法)

F

f (C++ function) favicon (內置变量) feed() (sphinxcontrib.websupport.search.BaseSearch 方法) figure_language_filename configuration value file (角色) file_suffix (內置变量) final_argument_whitespace (docutils.parsers.rst.Directive 属性) finish() (sphinx.builders.Builder 方法) finish_indexing() (sphinxcontrib.websupport.search.BaseSearch 方法) foo (指令) (角色) format (sphinx.builders.Builder 属性) (sphinx.builders.changes.ChangesBuilder 属性) (sphinx.builders.dirhtml.DirectoryHTMLBuilder 属性) (sphinx.builders.epub3.Epub3Builder 属性) (sphinx.builders.gettext.MessageCatalogBuilder 属性) (sphinx.builders.html.StandaloneHTMLBuilder 属性) (sphinx.builders.htmlhelp.HTMLHelpBuilder 属性) (sphinx.builders.latex.LaTeXBuilder 属性) (sphinx.builders.linkcheck.CheckExternalLinksBuilder 属性) (sphinx.builders.manpage.ManualPageBuilder 属性) (sphinx.builders.singlehtml.SingleFileHTMLBuilder 属性) (sphinx.builders.texinfo.TexinfoBuilder 属性) (sphinx.builders.text.TextBuilder 属性) (sphinx.builders.xml.PseudoXMLBuilder 属性) (sphinx.builders.xml.XMLBuilder 属性) (sphinxcontrib.applehelp.AppleHelpBuilder 属性) (sphinxcontrib.devhelp.DevhelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性)

found_docs (sphinx.environment.BuildEnvironment 属性) fresh-env configuration value fullname (內置变量) functions (內置变量)

G

generate() (sphinx.domains.Index 方法) get_data() (sphinxcontrib.websupport.storage.StorageBackend 方法) (sphinxcontrib.websupport.WebSupport 方法) get_document() (sphinxcontrib.websupport.WebSupport 方法) get_enumerable_node_type() (sphinx.domains.Domain 方法) get_full_qualified_name() (sphinx.domains.Domain 方法) get_objects() (sphinx.domains.Domain 方法) get_outdated_docs() (sphinx.builders.Builder 方法) (sphinx.environment.collectors.EnvironmentCollector 方法) get_relative_uri() (sphinx.builders.Builder 方法) get_search_results() (sphinxcontrib.websupport.WebSupport 方法) get_target_uri() (sphinx.builders.Builder 方法) get_translation() (在 sphinx.locale 模块中) get_type_name() (sphinx.domains.Domain 方法) get_updated_docs() (sphinx.environment.collectors.EnvironmentCollector 方法) getLogger() (在 sphinx.util.logging 模块中) gettext_additional_targets configuration value gettext_auto_build configuration value

gettext_compact configuration value gettext_location configuration value gettext_uuid configuration value global substitutions, [1], [2] globalcontext_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) glossary (sphinx.addnodes 中的类) (指令) graph (指令) graphviz (指令) graphviz_dot configuration value graphviz_dot_args configuration value graphviz_output_format configuration value guilabel (角色)

H

handle_query() (sphinxcontrib.websupport.search.BaseSearch 方法) has_content (docutils.parsers.rst.Directive 属性) has_explicit_title (sphinx.util.docutils.ReferenceRole 属性) has_source (內置变量) hasdoc() (內置函数) highlight (指令) highlight_language configuration value highlight_options configuration value highlightlang (sphinx.addnodes 中的类) hlist (指令) html-collect-pages event html-page-context event html4_writer configuration value html_add_permalinks configuration value html_additional_pages configuration value html_baseurl configuration value html_compact_lists configuration value html_context configuration value html_copy_source configuration value html_css_files configuration value html_domain_indices configuration value html_experimental_html5_writer configuration value html_extra_path configuration value html_favicon configuration value html_file_suffix configuration value html_js_files configuration value html_last_updated_fmt configuration value html_link_suffix configuration value html_logo configuration value html_math_renderer configuration value html_output_encoding configuration value html_scaled_image_link 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_sourcelink_suffix 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_use_index configuration value html_use_opensearch configuration value html_use_smartypants configuration value htmlhelp_basename configuration value htmlhelp_file_suffix configuration value htmlhelp_link_suffix configuration value HTMLHelpBuilder (sphinx.builders.htmlhelp 中的类) http:any (指令) (角色) http:copy (指令) (角色) http:delete (指令) (角色) http:get (指令) (角色) http:head (指令) (角色) http:header (角色) http:method (角色) http:options (指令) (角色) http:patch (指令) (角色) http:post (指令) (角色) http:put (指令) (角色) http:statuscode (角色) http:trace (指令) (角色)

I

ifconfig (指令) image_converter configuration value image_converter_args configuration value ImageConverter (sphinx.transforms.post_transforms.images 中的类) imgmath_add_tooltips configuration value imgmath_dvipng configuration value imgmath_dvipng_args configuration value imgmath_dvisvgm configuration value imgmath_dvisvgm_args configuration value imgmath_font_size configuration value imgmath_image_format configuration value imgmath_latex configuration value imgmath_latex_args configuration value imgmath_latex_preamble configuration value imgmath_use_preview configuration value implementation (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) in version changes

index (sphinx.addnodes 中的类) Index (sphinx.domains 中的类) index (指令) (角色) indices (sphinx.domains.Domain 属性) info() (sphinx.util.logging.SphinxLoggerAdapter 方法) inheritance-diagram (指令) inheritance_alias configuration value inheritance_edge_attrs configuration value inheritance_graph_attrs configuration value inheritance_node_attrs configuration value inherited_members (內置变量) init() (sphinx.application.TemplateBridge 方法) (sphinx.builders.Builder 方法) (在 sphinx.locale 模块中) init_console() (在 sphinx.locale 模块中) init_indexing() (sphinxcontrib.websupport.search.BaseSearch 方法) initial_data (sphinx.domains.Domain 属性) inliner (sphinx.util.docutils.SphinxRole 属性) intersphinx_cache_limit configuration value intersphinx_mapping configuration value intersphinx_timeout configuration value is_available() (sphinx.transforms.post_transforms.images.ImageConverter 方法) is_parallel_allowed() (sphinx.application.Sphinx 方法) is_supported() (sphinx.transforms.post_transforms.SphinxPostTransform 方法)

J

js:attr (角色) js:attribute (指令) js:class (指令) (角色) js:data (指令) (角色) js:func (角色)

js:function (指令) js:meth (角色) js:method (指令) js:mod (角色) js:module (指令) jsmath_path configuration value JSONHTMLBuilder (sphinxcontrib.serializinghtml 中的类)

K

kbd (角色) keep_warnings configuration value

keyword (角色)

L

label (sphinx.domains.Domain 属性) language configuration value language (內置变量) last_updated (內置变量) latex (模块) 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_engine configuration value latex_logo configuration value latex_show_pagerefs configuration value latex_show_urls configuration value latex_toplevel_sectioning configuration value latex_use_latex_multicolumn configuration value

latex_use_xindy configuration value LaTeXBuilder (sphinx.builders.latex 中的类) lineno (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性) link-index configuration value linkcheck_anchors configuration value linkcheck_anchors_ignore configuration value linkcheck_ignore configuration value linkcheck_retries configuration value linkcheck_timeout configuration value linkcheck_workers configuration value linkcode_resolve configuration value linking automatic literal_emphasis (sphinx.addnodes 中的类) literalinclude (指令) locale_dirs configuration value log() (sphinx.util.logging.SphinxLoggerAdapter 方法) logo (內置变量)

M

mailheader (角色), [1] makevar (角色) man_pages configuration value man_show_urls configuration value manpage (角色) manpages_url configuration value ManualPageBuilder (sphinx.builders.manpage 中的类) master_doc configuration value master_doc (內置变量) math (指令) (角色) math_eqref_format configuration value math_number_all configuration value math_numfig configuration value mathjax_config configuration value mathjax_options configuration value

mathjax_path configuration value members (內置变量) menuselection (角色) merge_domaindata() (sphinx.domains.Domain 方法) merge_other() (sphinx.environment.collectors.EnvironmentCollector 方法) MessageCatalogBuilder (sphinx.builders.gettext 中的类) meta (sphinx.addnodes 中的类) (內置变量) metadata (sphinx.environment.BuildEnvironment 属性) metatags (內置变量) methods (內置变量) mimetype (角色), [1] missing-reference event modindex_common_prefix configuration value module (內置变量) MyAnimal() (类) MyContainer (C++ type) MyContainer::const_iterator (C++ type) MyList (C++ type) MySortedContainer (C++ class) MyType (C++ type)

N

name (docutils.parsers.rst.Directive 属性) (sphinx.builders.Builder 属性) (sphinx.builders.changes.ChangesBuilder 属性) (sphinx.builders.dirhtml.DirectoryHTMLBuilder 属性) (sphinx.builders.dummy.DummyBuilder 属性) (sphinx.builders.epub3.Epub3Builder 属性) (sphinx.builders.gettext.MessageCatalogBuilder 属性) (sphinx.builders.html.StandaloneHTMLBuilder 属性) (sphinx.builders.htmlhelp.HTMLHelpBuilder 属性) (sphinx.builders.latex.LaTeXBuilder 属性) (sphinx.builders.linkcheck.CheckExternalLinksBuilder 属性) (sphinx.builders.manpage.ManualPageBuilder 属性) (sphinx.builders.singlehtml.SingleFileHTMLBuilder 属性) (sphinx.builders.texinfo.TexinfoBuilder 属性) (sphinx.builders.text.TextBuilder 属性) (sphinx.builders.xml.PseudoXMLBuilder 属性) (sphinx.builders.xml.XMLBuilder 属性) (sphinx.domains.Domain 属性) (sphinx.util.docutils.SphinxRole 属性) (sphinxcontrib.applehelp.AppleHelpBuilder 属性) (sphinxcontrib.devhelp.DevhelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性) (內置变量) napoleon_google_docstring configuration value napoleon_include_init_with_doc 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_keyword configuration value napoleon_use_param configuration value napoleon_use_rtype configuration value needs_extensions configuration value needs_sphinx configuration value new_serialno() (sphinx.environment.BuildEnvironment 方法) newest_template_mtime() (sphinx.application.TemplateBridge 方法) newsgroup (角色) next (內置变量) nitpick_ignore configuration value nitpicky configuration value, [1] note (指令) note_dependency() (sphinx.environment.BuildEnvironment 方法) note_reread() (sphinx.environment.BuildEnvironment 方法) numfig configuration value numfig_format configuration value numfig_secnum_depth configuration value numref (角色)

O

object (指令) object_types (sphinx.domains.Domain 属性) objname (內置变量) ObjType (sphinx.domains 中的类) only (sphinx.addnodes 中的类) (指令) option (指令) (角色) option_spec (docutils.parsers.rst.Directive 属性) optional_arguments (docutils.parsers.rst.Directive 属性) options (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性)

out_suffix (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) outdir (sphinx.application.Sphinx 属性) Outer (C++ class) Outer::Inner (C++ class) Outer<int> (C++ class) Outer<int>::Inner (C++ class) Outer<int>::Inner<bool> (C++ class) Outer<T *> (C++ class) overload_example::C (C++ class) overload_example::C::f (C++ function), [1], [2], [3]

P

page_source_suffix (內置变量) pagename (內置变量) parents (內置变量) Parser (sphinx.parsers 中的类) path2doc() (sphinx.project.Project 方法) pathto() (內置函数), [1] pdb configuration value pending_logging() (在 sphinx.util.logging 模块中) pending_warnings() (在 sphinx.util.logging 模块中) pending_xref (sphinx.addnodes 中的类) pep (角色) PickleHTMLBuilder (sphinxcontrib.serializinghtml 中的类) post_build() (sphinxcontrib.websupport.storage.StorageBackend 方法) pre_build() (sphinxcontrib.websupport.storage.StorageBackend 方法) prefixed_warnings() (在 sphinx.util.logging 模块中) prepare_writing() (sphinx.builders.Builder 方法) prev (內置变量) primary domain primary_domain configuration value process_doc() (sphinx.domains.Domain 方法) (sphinx.environment.collectors.EnvironmentCollector 方法) process_field_xref() (sphinx.domains.Domain 方法) process_vote() (sphinxcontrib.websupport.storage.StorageBackend 方法) (sphinxcontrib.websupport.WebSupport 方法) production (sphinx.addnodes 中的类) productionlist (sphinx.addnodes 中的类) (指令) program (指令) (角色)

project configuration value, [1] project (sphinx.application.Sphinx 属性) (sphinx.environment.BuildEnvironment 属性) Project (sphinx.project 中的类) 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 Python 提高建议 PEP 420

Q

qrefflask (指令) qthelp_basename configuration value qthelp_namespace configuration value

qthelp_theme configuration value qthelp_theme_options configuration value QtHelpBuilder (sphinxcontrib.qthelp 中的类) query() (sphinxcontrib.websupport.search.BaseSearch 方法)

R

rawtext (sphinx.util.docutils.SphinxRole 属性) ref (角色) ReferenceRole (sphinx.util.docutils 中的类) regexp (角色) relbar() (內置函数) reldelim1 (內置变量) reldelim2 (內置变量) release configuration value, [1] release (內置变量) relfn2path() (sphinx.environment.BuildEnvironment 方法) rellinks (內置变量) RemoveInSphinxXXXWarning render() (sphinx.application.TemplateBridge 方法) render_string() (sphinx.application.TemplateBridge 方法) require_sphinx() (sphinx.application.Sphinx 方法) required_arguments (docutils.parsers.rst.Directive 属性)

resolve_any_xref() (sphinx.domains.Domain 方法) resolve_xref() (sphinx.domains.Domain 方法) restore() (sphinx.project.Project 方法) reStructuredText rfc (角色) role() (sphinx.domains.Domain 方法) roles (sphinx.domains.Domain 属性) rst:dir (角色) rst:directive (指令) rst:role (指令) (角色) rst_epilog configuration value rst_prolog configuration value rubric (指令) run() (docutils.parsers.rst.Directive 方法) (sphinx.transforms.post_transforms.SphinxPostTransform 方法)

S

samp (角色) script_files (內置变量) searchindex_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) sectionauthor (指令) seealso (sphinx.addnodes 中的类) (指令) SerializingHTMLBuilder (sphinxcontrib.serializinghtml 中的类) set_source_info() (sphinx.util.docutils.SphinxDirective 方法) set_translator() (sphinx.application.Sphinx 方法) setup_extension() (sphinx.application.Sphinx 方法) shorttitle (內置变量) show_authors configuration value show_source (內置变量) sidebar() (內置函数) SingleFileHTMLBuilder (sphinx.builders.singlehtml 中的类) singlehtml_sidebars configuration value smartquotes configuration value smartquotes_action configuration value smartquotes_excludes configuration value snippets testing source-dir configuration value source-read event source_encoding configuration value source_parsers configuration value source_suffix configuration value source_suffix (sphinx.project.Project 属性) sourcecode sourcename (內置变量) Sphinx (sphinx.application 中的类), [1] sphinx-apidoc 命令行选项 --implicit-namespaces --tocfile -A <author> -E, --no-headings -F, --full -H <project> -M, --module-first -P, --private -R <release> -T, --no-toc -V <version> -a -d <MAXDEPTH> -e, --separate -f, --force -l, --follow-links -n, --dry-run -o <OUTPUT_PATH> -s <suffix> sphinx-autogen 命令行选项 -i, --imported-members -o <outputdir> -s <suffix>, --suffix <suffix> -t <templates>, --templates <templates> sphinx-build 命令行选项 --keep-going -A name=value -C -D setting=value -E -M buildername -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-quickstart 命令行选项 --batchfile, --no-batchfile --dot=DOT --ext-autodoc --ext-coverage --ext-doctest --ext-githubpages --ext-ifconfig --ext-imgmath --ext-intersphinx --ext-mathjax --ext-todo --ext-viewcode --extensions=EXTENSIONS --makefile, --no-makefile --master=MASTER --sep --suffix=SUFFIX --use-make-mode (-m), --no-use-make-mode (-M) -a AUTHOR, --author=AUTHOR -d NAME=VALUE -h, --help, --version -l LANGUAGE, --language=LANGUAGE -p PROJECT, --project=PROJECT -q, --quiet -r RELEASE, --release=RELEASE -t, --templatedir=TEMPLATEDIR -v VERSION

sphinx.addnodes (模块) sphinx.application (模块) sphinx.builders (模块) sphinx.builders.changes (模块) sphinx.builders.dirhtml (模块) sphinx.builders.dummy (模块) sphinx.builders.epub3 (模块) sphinx.builders.gettext (模块) sphinx.builders.html (模块) sphinx.builders.htmlhelp (模块) sphinx.builders.latex (模块) sphinx.builders.linkcheck (模块) sphinx.builders.manpage (模块) sphinx.builders.singlehtml (模块) sphinx.builders.texinfo (模块) sphinx.builders.text (模块) sphinx.builders.xml (模块) sphinx.domains (模块) sphinx.environment (模块) sphinx.environment.collectors (模块) sphinx.errors (模块) sphinx.ext.autodoc (模块) sphinx.ext.autosectionlabel (模块) sphinx.ext.autosummary (模块) sphinx.ext.coverage (模块) sphinx.ext.doctest (模块) sphinx.ext.extlinks (模块) sphinx.ext.githubpages (模块) sphinx.ext.graphviz (模块) sphinx.ext.ifconfig (模块) sphinx.ext.imgconverter (模块) sphinx.ext.imgmath (模块) sphinx.ext.inheritance_diagram (模块) sphinx.ext.intersphinx (模块) sphinx.ext.jsmath (模块) sphinx.ext.linkcode (模块) sphinx.ext.mathbase (模块) sphinx.ext.mathjax (模块) sphinx.ext.napoleon (模块) sphinx.ext.todo (模块) sphinx.ext.viewcode (模块) sphinx.parsers (模块) sphinx_version (內置变量) sphinxcontrib.applehelp (模块) sphinxcontrib.autohttp.bottle (模块) sphinxcontrib.autohttp.flask (模块) sphinxcontrib.autohttp.flaskqref (模块) sphinxcontrib.autohttp.tornado (模块) sphinxcontrib.devhelp (模块) sphinxcontrib.httpdomain (模块) sphinxcontrib.qthelp (模块) SphinxDirective (sphinx.util.docutils 中的类) SphinxError SphinxLoggerAdapter (sphinx.util.logging 中的类) SphinxPostTransform (sphinx.transforms.post_transforms 中的类) SphinxRole (sphinx.util.docutils 中的类) SphinxTransform (sphinx.transforms 中的类) srcdir (sphinx.application.Sphinx 属性) (sphinx.environment.BuildEnvironment 属性) (sphinx.project.Project 属性) StandaloneHTMLBuilder (sphinx.builders.html 中的类) start_of_file (sphinx.addnodes 中的类) state (docutils.parsers.rst.Directive 属性) state_machine (docutils.parsers.rst.Directive 属性) std::Iterator (C++ concept) StorageBackend (sphinxcontrib.websupport.storage 中的类) style (內置变量) substitutions global, [1], [2] supported_data_uri_images (sphinx.builders.Builder 属性) supported_image_types (sphinx.builders.Builder 属性) (sphinx.builders.changes.ChangesBuilder 属性) (sphinx.builders.dirhtml.DirectoryHTMLBuilder 属性) (sphinx.builders.dummy.DummyBuilder 属性) (sphinx.builders.epub3.Epub3Builder 属性) (sphinx.builders.gettext.MessageCatalogBuilder 属性) (sphinx.builders.html.StandaloneHTMLBuilder 属性) (sphinx.builders.htmlhelp.HTMLHelpBuilder 属性) (sphinx.builders.latex.LaTeXBuilder 属性) (sphinx.builders.linkcheck.CheckExternalLinksBuilder 属性) (sphinx.builders.manpage.ManualPageBuilder 属性) (sphinx.builders.singlehtml.SingleFileHTMLBuilder 属性) (sphinx.builders.texinfo.TexinfoBuilder 属性) (sphinx.builders.text.TextBuilder 属性) (sphinx.builders.xml.PseudoXMLBuilder 属性) (sphinx.builders.xml.XMLBuilder 属性) (sphinxcontrib.applehelp.AppleHelpBuilder 属性) (sphinxcontrib.devhelp.DevhelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性) supported_remote_images (sphinx.builders.Builder 属性) suppress_warnings configuration value

T

table of contents tabularcolumns (指令) target (sphinx.util.docutils.ReferenceRole 属性) 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_no_detailmenu configuration value texinfo_show_urls configuration value TexinfoBuilder (sphinx.builders.texinfo 中的类) text (sphinx.util.docutils.SphinxRole 属性) text_add_secnumbers configuration value text_newlines configuration value

text_secnumber_suffix configuration value text_sectionchars configuration value TextBuilder (sphinx.builders.text 中的类) ThemeError title (sphinx.util.docutils.ReferenceRole 属性) (內置变量), [1] titles (sphinx.environment.BuildEnvironment 属性) tls_cacerts configuration value tls_verify configuration value toc (內置变量) toctree (sphinx.addnodes 中的类) (內置变量) (指令) today configuration value, [1] today_fmt configuration value todo (指令) todo-defined event todo_emit_warnings configuration value todo_include_todos configuration value todo_link_only configuration value todolist (指令) token (角色) trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

underline (內置变量) underline() (內置函数)

update_username() (sphinxcontrib.websupport.storage.StorageBackend 方法) use_opensearch (內置变量)

V

verbose() (sphinx.util.logging.SphinxLoggerAdapter 方法) version configuration value, [1] version (內置变量) version_info() (在 sphinx 模块中) versionadded (指令) versionchanged (指令) versionmodified (sphinx.addnodes 中的类)

VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub configuration value viewcode_follow_imported_members configuration value

W

warning (指令) warning() (sphinx.util.logging.SphinxLoggerAdapter 方法) (內置函数) warning-is-error configuration value

WebSupport (sphinxcontrib.websupport 中的类) Wrapper (C++ class) Wrapper::Outer (C++ class) Wrapper::Outer::Inner (C++ class) write_doc() (sphinx.builders.Builder 方法)

X

xml_pretty configuration value

XMLBuilder (sphinx.builders.xml 中的类)

主

主文件

域

域

对

对象

扩

扩展

指

指令

文

文件名

构

构建器

源

源目录

环

环境	环境变量 SPHINX_APIDOC_OPTIONS

角

角色

配

配置目录