索引

符号

--author sphinx-quickstart 命令行选项 --batchfile sphinx-quickstart 命令行选项 --builder sphinx-build 命令行选项 --color sphinx-build 命令行选项 --conf-dir sphinx-build 命令行选项 --define sphinx-build 命令行选项 --doctree-dir sphinx-build 命令行选项 --dot sphinx-quickstart 命令行选项 --dry-run sphinx-apidoc 命令行选项 --exception-on-warning sphinx-build 命令行选项 --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 sphinx-quickstart 命令行选项 --fail-on-warning sphinx-build 命令行选项 --follow-links sphinx-apidoc 命令行选项 --force sphinx-apidoc 命令行选项 --fresh-env sphinx-build 命令行选项 --full sphinx-apidoc 命令行选项 --help sphinx-build 命令行选项 sphinx-quickstart 命令行选项 --html-define sphinx-build 命令行选项 --implicit-namespaces sphinx-apidoc 命令行选项 --imported-members sphinx-autogen 命令行选项 --isolated sphinx-build 命令行选项 --jobs sphinx-build 命令行选项 --keep-going sphinx-build 命令行选项 --language sphinx-quickstart 命令行选项 --makefile sphinx-quickstart 命令行选项 --master sphinx-quickstart 命令行选项 --module-first sphinx-apidoc 命令行选项 --nitpicky sphinx-build 命令行选项 --no-batchfile sphinx-quickstart 命令行选项 --no-color sphinx-build 命令行选项 --no-headings sphinx-apidoc 命令行选项 --no-makefile sphinx-quickstart 命令行选项 --no-sep sphinx-quickstart 命令行选项 --no-toc sphinx-apidoc 命令行选项 --no-use-make-mode sphinx-quickstart 命令行选项 --pdb sphinx-build 命令行选项 --private sphinx-apidoc 命令行选项 --project sphinx-quickstart 命令行选项 --quiet sphinx-build 命令行选项 sphinx-quickstart 命令行选项 --release sphinx-quickstart 命令行选项 --remove-old sphinx-apidoc 命令行选项 sphinx-autogen 命令行选项 --respect-module-all sphinx-autogen 命令行选项 --sep sphinx-quickstart 命令行选项 --separate sphinx-apidoc 命令行选项 --show-traceback sphinx-build 命令行选项

--silent sphinx-build 命令行选项 --suffix sphinx-autogen 命令行选项 sphinx-quickstart 命令行选项 --tag sphinx-build 命令行选项 --templatedir sphinx-apidoc 命令行选项 sphinx-quickstart 命令行选项 --templates sphinx-autogen 命令行选项 --tocfile sphinx-apidoc 命令行选项 --use-make-mode sphinx-quickstart 命令行选项 --verbose sphinx-build 命令行选项 --version sphinx-build 命令行选项 sphinx-quickstart 命令行选项 --warning-file sphinx-build 命令行选项 --write-all sphinx-build 命令行选项 -A sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -a sphinx-apidoc 命令行选项 sphinx-autogen 命令行选项 sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -b sphinx-build 命令行选项 -C sphinx-build 命令行选项 -c sphinx-build 命令行选项 -D sphinx-build 命令行选项 -d sphinx-apidoc 命令行选项 sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -E sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -e sphinx-apidoc 命令行选项 -F sphinx-apidoc 命令行选项 -f sphinx-apidoc 命令行选项 -H sphinx-apidoc 命令行选项 -h sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -i sphinx-autogen 命令行选项 -j sphinx-build 命令行选项 -l sphinx-apidoc 命令行选项 sphinx-quickstart 命令行选项 -M sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -N sphinx-build 命令行选项 -n sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -o sphinx-apidoc 命令行选项 sphinx-autogen 命令行选项 -P sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -p sphinx-quickstart 命令行选项 -Q sphinx-build 命令行选项 -q sphinx-apidoc 命令行选项 sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -R sphinx-apidoc 命令行选项 -r sphinx-quickstart 命令行选项 -s sphinx-apidoc 命令行选项 sphinx-autogen 命令行选项 -T sphinx-apidoc 命令行选项 sphinx-build 命令行选项 -t sphinx-apidoc 命令行选项 sphinx-autogen 命令行选项 sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -V sphinx-apidoc 命令行选项 -v sphinx-build 命令行选项 sphinx-quickstart 命令行选项 -W sphinx-build 命令行选项 -w sphinx-build 命令行选项

_

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

_object_hierarchy_parts() (sphinx.directives.ObjectDescription 方法) _parser (sphinx.environment.BuildEnvironment.current_document 属性) _toc_entry_name() (sphinx.directives.ObjectDescription 方法)

A

:abstract: (指令选项) py:class (指令) py:method (指令) py:property (指令) :abstractmethod: (指令选项) py:method (指令) py:property (指令) :align: (指令选项) digraph (指令) graph (指令) graphviz (指令) :alt: (指令选项) digraph (指令) graph (指令) graphviz (指令) :annotation: (指令选项) autodata (指令) :append: (指令选项) literalinclude (指令) :async: (指令选项) py:function (指令) py:method (指令) abbr (角色) accept_comment() (sphinxcontrib.websupport.storage.StorageBackend 方法) add() (sphinx.events.EventManager 方法) 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 方法) add_directive_to_domain() (sphinx.application.Sphinx 方法) 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 配置值 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_linkcode_domain() (在模块 sphinx.ext.linkcode 中) add_message_catalog() (sphinx.application.Sphinx 方法) add_module_names 配置值 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_target_and_index() (sphinx.directives.ObjectDescription 方法) add_transform() (sphinx.application.Sphinx 方法) added 在版本 admonition attention caution danger error hint important note tip warning admonition (指令) admonitions after_content() (sphinx.directives.ObjectDescription 方法) allow_parallel (sphinx.builders.Builder 属性) anchor (sphinx.domains.IndexEntry 属性) any (角色) apidoc_automodule_options 配置值 apidoc_exclude_patterns 配置值 apidoc_follow_links 配置值 apidoc_implicit_namespaces 配置值 apidoc_include_private 配置值 apidoc_max_depth 配置值 apidoc_module_first 配置值 apidoc_modules 配置值 apidoc_no_headings 配置值 apidoc_separate_modules 配置值 app (sphinx.environment.BuildEnvironment 属性) (sphinx.transforms.SphinxTransform 属性) 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 配置值 AppleHelpBuilder (类，位于 sphinxcontrib.applehelp 中) apply() (sphinx.transforms.post_transforms.SphinxPostTransform 方法) arguments (docutils.parsers.rst.Directive 属性) attention admonition attention (指令) attributes (内置变量) author 配置值 autoattribute (指令) autoclass (指令) :class-doc-from: (指令选项) :exclude-members: (指令选项) :inherited-members: (指令选项) :member-order: (指令选项) :members: (指令选项) :no-index-entry: (指令选项) :no-index: (指令选项) :private-members: (指令选项) :show-inheritance: (指令选项) :special-members: (指令选项) :undoc-members: (指令选项) autoclass_content 配置值 autodata (指令) :annotation: (指令选项) :no-index-entry: (指令选项) :no-index: (指令选项) :no-value: (指令选项) autodecorator (指令) autodoc-before-process-signature 事件 autodoc-process-bases 事件 autodoc-process-docstring 事件 autodoc-process-signature 事件 autodoc-skip-member 事件 autodoc_class_signature 配置值 autodoc_default_options 配置值 autodoc_docstring_signature 配置值 autodoc_inherit_docstrings 配置值 autodoc_member_order 配置值 autodoc_mock_imports 配置值 autodoc_preserve_defaults 配置值 autodoc_type_aliases 配置值 autodoc_typehints 配置值 autodoc_typehints_description_target 配置值 autodoc_typehints_format 配置值 autodoc_use_type_comments 配置值 autodoc_warningiserror 配置值 autoexception (指令) autofunction (指令) :no-index-entry: (指令选项) :no-index: (指令选项) automatic 文档, [1] 链接 测试 automethod (指令) automodule (指令) :deprecated: (指令选项) :exclude-members: (指令选项) :ignore-module-all: (指令选项) :imported-members: (指令选项) :member-order: (指令选项) :members: (指令选项) :no-index-entry: (指令选项) :no-index: (指令选项) :platform: (指令选项) :private-members: (指令选项) :show-inheritance: (指令选项) :special-members: (指令选项) :synopsis: (指令选项) :undoc-members: (指令选项) autoproperty (指令) autosectionlabel_maxdepth 配置值 autosectionlabel_prefix_document 配置值 autosummary (指令) :caption: (指令选项) :class: (指令选项) :nosignatures: (指令选项) :recursive: (指令选项) :signatures: (指令选项) :template: (指令选项) :toctree: (指令选项) autosummary_context 配置值 autosummary_filename_map 配置值 autosummary_generate 配置值 autosummary_generate_overwrite 配置值 autosummary_ignore_module_all 配置值 autosummary_imported_members 配置值 autosummary_mock_imports 配置值 available (sphinx.transforms.post_transforms.images.ImageConverter 属性)

B

BaseSearch (类，位于 sphinxcontrib.websupport.search 中) before_content() (sphinx.directives.ObjectDescription 方法) between() (在模块 sphinx.ext.autodoc 中) block_text (docutils.parsers.rst.Directive 属性) body (内置变量) build() (sphinx.builders.Builder 方法) (sphinxcontrib.websupport.WebSupport 方法) build-finished 事件 build_all() (sphinx.builders.Builder 方法) build_specific() (sphinx.builders.Builder 方法) build_update() (sphinx.builders.Builder 方法) BuildEnvironment (类，位于 sphinx.environment 中)

builder (内置变量) Builder (类，位于 sphinx.builders 中) builder-inited 事件 内置函数 enumerate() escape() hasdoc() pathto() relbar() sidebar() warning()

C

:canonical: (指令选项) py:attribute (指令) py:class (指令) py:data (指令) py:function (指令) py:method (指令) py:type (指令) :caption: (指令选项) autosummary (指令) code-block (指令) digraph (指令) graph (指令) graphviz (指令) literalinclude (指令) toctree (指令) :class-doc-from: (指令选项) autoclass (指令) :class: (指令选项) autosummary (指令) code-block (指令) digraph (指令) graph (指令) graphviz (指令) literalinclude (指令) math (指令) rubric (指令) toctree (指令) :classmethod: (指令选项) py:method (指令) py:property (指令) :columns: (指令选项) hlist (指令) c:alias (指令) :maxdepth: (指令选项) :noroot: (指令选项) c:data (角色) c:enum (指令) (角色) c:enumerator (指令) (角色) c:expr (角色) c:func (角色) c:function (指令) :single-line-parameter-list: (指令选项) c:macro (指令) :single-line-parameter-list: (指令选项) c:macro (角色) c:member (指令) (角色) c:namespace (指令) c:namespace-pop (指令) c:namespace-push (指令) c:struct (指令) (角色) c:texpr (角色) c:type (指令) (角色) c:union (指令) (角色) c:var (指令) (角色) c_extra_keywords 配置值 c_id_attributes 配置值 c_maximum_signature_line_length 配置值 c_paren_attributes 配置值 category (sphinx.errors.SphinxError 属性) caution admonition caution (指令) centered (指令) changes 在版本 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 例子 code (指令) (角色) code-block (指令) :caption: (指令选项) :class: (指令选项) :dedent: (指令选项) :emphasize-lines: (指令选项) :force: (指令选项) :lineno-start: (指令选项) :linenos: (指令选项) :name: (指令选项) codeauthor (指令) command (角色) Common Vulnerabilities and Exposures CVE 2020-10735 Common Weakness Enumeration CWE 787 compact_paragraph (类，位于 sphinx.addnodes 中) conf 模块 confdir (sphinx.application.Sphinx 属性) Config (类，位于 sphinx.config 中) config (sphinx.environment.BuildEnvironment 属性) (sphinx.parsers.Parser 属性) (sphinx.transforms.SphinxTransform 属性) (sphinx.util.docutils.SphinxDirective 属性) (sphinx.util.docutils.SphinxRole 属性) config-inited 事件 ConfigError 配置目录 配置值 add_function_parentheses add_module_names apidoc_automodule_options apidoc_exclude_patterns apidoc_follow_links apidoc_implicit_namespaces apidoc_include_private apidoc_max_depth apidoc_module_first apidoc_modules apidoc_no_headings apidoc_separate_modules 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_class_signature autodoc_default_options autodoc_docstring_signature autodoc_inherit_docstrings autodoc_member_order autodoc_mock_imports autodoc_preserve_defaults autodoc_type_aliases autodoc_typehints autodoc_typehints_description_target autodoc_typehints_format autodoc_use_type_comments autodoc_warningiserror autosectionlabel_maxdepth autosectionlabel_prefix_document autosummary_context autosummary_filename_map autosummary_generate autosummary_generate_overwrite autosummary_ignore_module_all autosummary_imported_members autosummary_mock_imports c_extra_keywords c_id_attributes c_maximum_signature_line_length c_paren_attributes copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules coverage_ignore_pyobjects coverage_modules coverage_show_missing_items coverage_skip_undoc_in_source coverage_statistics_to_report coverage_statistics_to_stdout coverage_write_headline cpp_id_attributes cpp_index_common_prefix cpp_maximum_signature_line_length cpp_paren_attributes default_role doctest_default_flags doctest_global_cleanup doctest_global_setup doctest_path doctest_show_successes 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 extlinks_detect_hardcoded_links figure_language_filename gettext_additional_targets gettext_allow_fuzzy_translations gettext_auto_build gettext_compact gettext_location gettext_uuid graphviz_dot graphviz_dot_args graphviz_output_format highlight_language highlight_options html_additional_pages html_baseurl html_codeblock_linenos_style html_compact_lists html_context html_copy_source html_css_files html_domain_indices html_extra_path html_favicon html_file_suffix html_js_files html_last_updated_fmt html_last_updated_use_utc html_link_suffix html_logo html_math_renderer html_output_encoding html_permalinks html_permalinks_icon html_scaled_image_link html_search_language html_search_options html_search_scorer html_secnumber_suffix html_short_title html_show_copyright html_show_search_summary 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 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_embed imgmath_font_size imgmath_image_format imgmath_latex imgmath_latex_args imgmath_latex_preamble imgmath_use_preview include_patterns inheritance_alias inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_disabled_reftypes intersphinx_mapping intersphinx_resolve_self intersphinx_timeout javascript_maximum_signature_line_length javascript_trailing_comma_in_multi_line_signatures 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_table_style latex_theme latex_theme_options latex_theme_path latex_toplevel_sectioning latex_use_latex_multicolumn latex_use_xindy linkcheck_allow_unauthorized linkcheck_allowed_redirects linkcheck_anchors linkcheck_anchors_ignore linkcheck_anchors_ignore_for_url linkcheck_auth linkcheck_exclude_documents linkcheck_ignore linkcheck_rate_limit_timeout linkcheck_report_timeouts_as_broken linkcheck_request_headers linkcheck_retries linkcheck_timeout linkcheck_workers linkcode_resolve locale_dirs man_make_section_directory man_pages man_show_urls manpages_url master_doc math_eqref_format math_number_all math_numfig math_numsep mathjax2_config mathjax3_config mathjax_config mathjax_options mathjax_path maximum_signature_line_length modindex_common_prefix napoleon_attr_annotations napoleon_custom_sections napoleon_google_docstring napoleon_include_init_with_doc napoleon_include_private_with_doc napoleon_include_special_with_doc napoleon_numpy_docstring napoleon_preprocess_types napoleon_type_aliases 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 nitpick_ignore_regex nitpicky numfig numfig_format numfig_secnum_depth option_emphasise_placeholders primary_domain project project_copyright pygments_style python_display_short_literal_types python_maximum_signature_line_length python_trailing_comma_in_multi_line_signatures python_use_unqualified_type_names qthelp_basename qthelp_namespace qthelp_theme qthelp_theme_options release root_doc rst_epilog rst_prolog show_authors show_warning_types singlehtml_sidebars smartquotes smartquotes_action smartquotes_excludes source_encoding source_suffix strip_signature_backslash suppress_warnings template_bridge templates_path texinfo_appendices texinfo_cross_references texinfo_documents texinfo_domain_indices texinfo_elements texinfo_no_detailmenu texinfo_show_urls text_add_secnumbers text_newlines text_secnumber_suffix text_sectionchars the_answer tls_cacerts tls_verify toc_object_entries toc_object_entries_show_parents today today_fmt todo_emit_warnings todo_include_todos todo_link_only translation_progress_classes trim_doctest_flags trim_footnote_reference_space user_agent version viewcode_enable_epub viewcode_follow_imported_members viewcode_line_numbers xml_pretty

confval (指令) :default: (指令选项) :type: (指令选项) confval (角色) connect() (sphinx.application.Sphinx 方法) (sphinx.events.EventManager 方法) content (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性) content_offset (docutils.parsers.rst.Directive 属性) contents 目录 conversion_rules (sphinx.transforms.post_transforms.images.ImageConverter 属性) convert() (sphinx.transforms.post_transforms.images.ImageConverter 方法) copy_assets() (sphinx.builders.Builder 方法) copyright 配置值 copyright (内置变量) coverage_c_path 配置值 coverage_c_regexes 配置值 coverage_ignore_c_items 配置值 coverage_ignore_classes 配置值 coverage_ignore_functions 配置值 coverage_ignore_modules 配置值 coverage_ignore_pyobjects 配置值 coverage_modules 配置值 coverage_show_missing_items 配置值 coverage_skip_undoc_in_source 配置值 coverage_statistics_to_report 配置值 coverage_statistics_to_stdout 配置值 coverage_write_headline 配置值 CoverageBuilder (类，位于 sphinx.ext.coverage 中) cpp:alias (指令) :maxdepth: (指令选项) :noroot: (指令选项) cpp:any (角色) cpp:class (指令) (角色) cpp:concept (指令) (角色) cpp:enum (指令) (角色) cpp:enum-class (指令) cpp:enum-struct (指令) cpp:enumerator (指令) (角色) cpp:expr (角色) cpp:func (角色) cpp:function (指令) :single-line-parameter-list: (指令选项) cpp:member (指令) (角色) cpp:namespace (指令) cpp:namespace-pop (指令) cpp:namespace-push (指令) cpp:struct (指令) (角色) cpp:texpr (角色) cpp:type (指令) (角色) cpp:union (指令) cpp:var (指令) (角色) cpp_id_attributes 配置值 cpp_index_common_prefix 配置值 cpp_maximum_signature_line_length 配置值 cpp_paren_attributes 配置值 critical() (sphinx.util.logging.SphinxLoggerAdapter 方法) current_document (sphinx.environment.BuildEnvironment 属性) CustomList (C++ 类型) cut_lines() (在模块 sphinx.ext.autodoc 中) cve (角色) cwe (角色)

D

:dedent: (指令选项) code-block (指令) literalinclude (指令) :default: (指令选项) confval (指令) :deprecated: (指令选项) automodule (指令) py:module (指令) :diff: (指令选项) literalinclude (指令) danger admonition danger (指令) dangling_warnings (sphinx.domains.Domain 属性) data (sphinx.domains.Domain 属性) data_version (sphinx.domains.Domain 属性) debug() (sphinx.util.logging.SphinxLoggerAdapter 方法) default 域 角色 default-domain (指令) default_domain (sphinx.environment.BuildEnvironment.current_document 属性) default_priority (sphinx.transforms.post_transforms.images.ImageConverter 属性) default_role 配置值 default_role (sphinx.environment.BuildEnvironment.current_document 属性) 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_inline (类，位于 sphinx.addnodes 中) desc_name (类，位于 sphinx.addnodes 中) desc_optional (类，位于 sphinx.addnodes 中) desc_parameter (类，位于 sphinx.addnodes 中) desc_parameterlist (类，位于 sphinx.addnodes 中) desc_returns (类，位于 sphinx.addnodes 中) desc_sig_element (类，位于 sphinx.addnodes 中) desc_sig_keyword (类，位于 sphinx.addnodes 中) desc_sig_keyword_type (类，位于 sphinx.addnodes 中) desc_sig_literal_char (类，位于 sphinx.addnodes 中) desc_sig_literal_number (类，位于 sphinx.addnodes 中) desc_sig_literal_string (类，位于 sphinx.addnodes 中) desc_sig_name (类，位于 sphinx.addnodes 中) desc_sig_operator (类，位于 sphinx.addnodes 中) desc_sig_punctuation (类，位于 sphinx.addnodes 中) desc_sig_space (类，位于 sphinx.addnodes 中) desc_signature (类，位于 sphinx.addnodes 中) desc_signature_line (类，位于 sphinx.addnodes 中) desc_type (类，位于 sphinx.addnodes 中) descr (sphinx.domains.IndexEntry 属性) describe (指令) DevhelpBuilder (类，位于 sphinxcontrib.devhelp 中) dfn (角色) digraph (指令) :align: (指令选项) :alt: (指令选项) :caption: (指令选项) :class: (指令选项) :layout: (指令选项) :name: (指令选项)

directive Directive (类，位于 docutils.parsers.rst 中) directive() (sphinx.domains.Domain 方法) directives (sphinx.domains.Domain 属性) DirectoryHTMLBuilder (类，位于 sphinx.builders.dirhtml 中) disabled (sphinx.util.docutils.ReferenceRole 属性) disconnect() (sphinx.application.Sphinx 方法) (sphinx.events.EventManager 方法) discover() (sphinx.project.Project 方法) display_toc (内置变量) doc (角色) doc2path() (sphinx.environment.BuildEnvironment 方法) (sphinx.project.Project 方法) docname (sphinx.domains.IndexEntry 属性) (sphinx.environment.BuildEnvironment 属性) (sphinx.environment.BuildEnvironment.current_document 属性) docnames (sphinx.project.Project 属性) docstitle (内置变量) docstring doctest doctest (指令) :hide: (指令选项) :no-trim-doctest-flags: (指令选项) :options: (指令选项) :pyversion: (指令选项) :skipif: (指令选项) :trim-doctest-flags: (指令选项) doctest_default_flags 配置值 doctest_global_cleanup 配置值 doctest_global_setup 配置值 doctest_path 配置值 doctest_show_successes 配置值 doctest_test_doctest_blocks 配置值 doctree-read 事件 doctree-resolved 事件 doctreedir (sphinx.application.Sphinx 属性) (sphinx.environment.BuildEnvironment 属性) 文档名 文档 自动, [1] 生成 生成 docutils.parsers.rst 模块 docutils_version_info (内置变量) 域 default Domain (类，位于 sphinx.domains 中) download (角色) download_reference (类，位于 sphinx.addnodes 中) DummyBuilder (类，位于 sphinx.builders.dummy 中)

E

:emphasize-lines: (指令选项) code-block (指令) literalinclude (指令) :encoding: (指令选项) literalinclude (指令) :end-at: (指令选项) literalinclude (指令) :end-before: (指令选项) literalinclude (指令) :exclude-members: (指令选项) autoclass (指令) automodule (指令) embedded (内置变量) emit() (sphinx.application.Sphinx 方法) (sphinx.events.EventManager 方法) emit_firstresult() (sphinx.application.Sphinx 方法) (sphinx.events.EventManager 方法) ENUM (类，位于 sphinx.config 中) enumerable_nodes (sphinx.domains.Domain 属性) enumerate() 内置函数 env (sphinx.parsers.Parser 属性) (sphinx.transforms.SphinxTransform 属性) (sphinx.util.docutils.SphinxDirective 属性) (sphinx.util.docutils.SphinxRole 属性) env-before-read-docs 事件 env-check-consistency 事件 env-get-outdated 事件 env-get-updated 事件 env-merge-info 事件 env-purge-doc 事件 env-updated 事件 env_version (sphinx.util.typing.ExtensionMetadata 属性) 环境 环境变量 python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS EnvironmentCollector (类，位于 sphinx.environment.collectors 中) envvar (指令) (角色) epilog (sphinx.builders.Builder 属性) Epub3Builder (类，位于 sphinx.builders.epub3 中) 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 配置值 eq (角色) error admonition error (指令) error() (sphinx.util.logging.SphinxLoggerAdapter 方法) escape() 内置函数 事件 autodoc-before-process-signature autodoc-process-bases 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-get-updated env-merge-info env-purge-doc env-updated html-collect-pages html-page-context include-read linkcheck-process-uri missing-reference object-description-transform source-read todo-defined viewcode-find-source viewcode-follow-imported warn-missing-reference write-started EventManager (类，位于 sphinx.events 中) events (sphinx.builders.Builder 属性) (sphinx.environment.BuildEnvironment 属性) 例子 code exceptions (内置变量) exclude_patterns 配置值 扩展 ExtensionError, [1] ExtensionMetadata (类，位于 sphinx.util.typing 中) extensions 配置值 external (角色) extlinks 配置值 extlinks_detect_hardcoded_links 配置值 extra (sphinx.domains.IndexEntry 属性) extract_context() (sphinxcontrib.websupport.search.BaseSearch 方法)

F

:final: (指令选项) py:class (指令) py:exception (指令) py:method (指令) :force: (指令选项) code-block (指令) highlight (指令) literalinclude (指令) favicon_url (内置变量) feed() (sphinxcontrib.websupport.search.BaseSearch 方法) figure_language_filename 配置值 file (角色) file_suffix (内置变量) final_argument_whitespace (docutils.parsers.rst.Directive 属性) (sphinx.directives.ObjectDescription 属性) finish() (sphinx.builders.Builder 方法) finish_indexing() (sphinxcontrib.websupport.search.BaseSearch 方法) 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.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.htmlhelp.HTMLHelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性)

found_docs (sphinx.environment.BuildEnvironment 属性) fresh_env_used (sphinx.application.Sphinx 属性) fullname (内置变量) functions (内置变量)

G

:glob: (指令选项) toctree (指令) 生成 文档 generate() (sphinx.domains.Index 方法) 生成 文档 genindex toctree 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_location() (sphinx.util.docutils.SphinxDirective 方法) (sphinx.util.docutils.SphinxRole 方法) 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_signatures() (sphinx.directives.ObjectDescription 方法) get_source_info() (sphinx.util.docutils.SphinxDirective 方法) 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 配置值 gettext_allow_fuzzy_translations 配置值 gettext_auto_build 配置值

gettext_compact 配置值 gettext_location 配置值 gettext_uuid 配置值 global 替换, [1], [2] globalcontext_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) glossary (类，位于 sphinx.addnodes 中) glossary (指令) :sorted: (指令选项) graph (指令) :align: (指令选项) :alt: (指令选项) :caption: (指令选项) :class: (指令选项) :layout: (指令选项) :name: (指令选项) graphviz (指令) :align: (指令选项) :alt: (指令选项) :caption: (指令选项) :class: (指令选项) :layout: (指令选项) :name: (指令选项) graphviz_dot 配置值 graphviz_dot_args 配置值 graphviz_output_format 配置值 guilabel (角色)

H

:heading-level: (指令选项) rubric (指令) :hidden: (指令选项) toctree (指令) :hide: (指令选项) doctest (指令) testcode (指令) testoutput (指令) handle_query() (sphinxcontrib.websupport.search.BaseSearch 方法) handle_signature() (sphinx.directives.ObjectDescription 方法) has_content (docutils.parsers.rst.Directive 属性) (sphinx.directives.ObjectDescription 属性) has_explicit_title (sphinx.util.docutils.ReferenceRole 属性) has_source (内置变量) hasdoc() 内置函数 highlight (指令) :force: (指令选项) :linenothreshold: (指令选项) highlight_language 配置值 highlight_language (sphinx.environment.BuildEnvironment.current_document 属性) highlight_options 配置值 highlightlang (类，位于 sphinx.addnodes 中) hint admonition hint (指令) hlist (指令) :columns: (指令选项) html-collect-pages 事件 html-page-context 事件 html_additional_pages 配置值 html_baseurl 配置值 html_codeblock_linenos_style 配置值 html_compact_lists 配置值 html_context 配置值 html_copy_source 配置值 html_css_files 配置值 html_domain_indices 配置值 html_extra_path 配置值 html_favicon 配置值 html_file_suffix 配置值 html_js_files 配置值 html_last_updated_fmt 配置值 html_last_updated_use_utc 配置值

html_link_suffix 配置值 html_logo 配置值 html_math_renderer 配置值 html_output_encoding 配置值 html_permalinks 配置值 html_permalinks_icon 配置值 html_scaled_image_link 配置值 html_search_language 配置值 html_search_options 配置值 html_search_scorer 配置值 html_secnumber_suffix 配置值 html_short_title 配置值 html_show_copyright 配置值 html_show_search_summary 配置值 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 配置值 htmlhelp_basename 配置值 htmlhelp_file_suffix 配置值 htmlhelp_link_suffix 配置值 HTMLHelpBuilder (类，位于 sphinxcontrib.htmlhelp 中)

I

:ignore-module-all: (指令选项) automodule (指令) :imported-members: (指令选项) automodule (指令) :include-subclasses: (指令选项) inheritance-diagram (指令) :includehidden: (指令选项) toctree (指令) :inherited-members: (指令选项) autoclass (指令) ifconfig (指令) image_converter 配置值 image_converter_args 配置值 ImageConverter (类，位于 sphinx.transforms.post_transforms.images 中) imgmath_add_tooltips 配置值 imgmath_dvipng 配置值 imgmath_dvipng_args 配置值 imgmath_dvisvgm 配置值 imgmath_dvisvgm_args 配置值 imgmath_embed 配置值 imgmath_font_size 配置值 imgmath_image_format 配置值 imgmath_latex 配置值 imgmath_latex_args 配置值 imgmath_latex_preamble 配置值 imgmath_use_preview 配置值 implementation (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) important admonition important (指令) 在版本 added changes 已移除

include-read 事件 include_patterns 配置值 index (sphinx.addnodes 中的类) Index (sphinx.domains 中的类) index (指令) :name: (指令选项) index (角色) IndexEntry (sphinx.domains 中的类) indices (sphinx.domains.Domain 属性) info() (sphinx.util.logging.SphinxLoggerAdapter 方法) inheritance-diagram (指令) :include-subclasses: (指令选项) inheritance_alias 配置值 inheritance_edge_attrs 配置值 inheritance_graph_attrs 配置值 inheritance_node_attrs 配置值 inherited_members (内置变量) init() (在 sphinx.locale 模块中) (sphinx.application.TemplateBridge 方法) (sphinx.builders.Builder 方法) init_console() (在 sphinx.locale 模块中) init_indexing() (sphinxcontrib.websupport.search.BaseSearch 方法) initial_data (sphinx.domains.Domain 属性) inliner (sphinx.util.docutils.SphinxRole 属性) intersphinx_cache_limit 配置值 intersphinx_disabled_reftypes 配置值 intersphinx_mapping 配置值 intersphinx_resolve_self 配置值 intersphinx_timeout 配置值 is_available() (sphinx.transforms.post_transforms.images.ImageConverter 方法) is_parallel_allowed() (sphinx.application.Sphinx 方法) is_supported() (sphinx.transforms.post_transforms.SphinxPostTransform 方法)

J

javascript_maximum_signature_line_length 配置值 javascript_trailing_comma_in_multi_line_signatures 配置值 js:attr (角色) js:attribute (指令) js:class (指令) :single-line-parameter-list: (指令选项) js:class (角色) js:data (指令) (角色)

js:func (角色) js:function (指令) :single-line-parameter-list: (指令选项) js:meth (角色) js:method (指令) :single-line-parameter-list: (指令选项) js:mod (角色) js:module (指令) jsmath_path 配置值 JSONHTMLBuilder (sphinxcontrib.serializinghtml 中的类)

K

kbd (角色) keep_warnings 配置值

keyword (角色)

L

:label: (指令选项) math (指令) :language: (指令选项) literalinclude (指令) :layout: (指令选项) digraph (指令) graph (指令) graphviz (指令) :lineno-match: (指令选项) literalinclude (指令) :lineno-start: (指令选项) code-block (指令) literalinclude (指令) :linenos: (指令选项) code-block (指令) literalinclude (指令) :linenothreshold: (指令选项) highlight (指令) :lines: (指令选项) literalinclude (指令) label (sphinx.domains.Domain 属性) language 配置值 language (内置变量) last_updated (内置变量) latex 模块 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_table_style 配置值 latex_theme 配置值 latex_theme_options 配置值 latex_theme_path 配置值 latex_toplevel_sectioning 配置值 latex_use_latex_multicolumn 配置值 latex_use_xindy 配置值 LaTeXBuilder (sphinx.builders.latex 中的类)

lineno (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性) linkcheck-process-uri 事件 linkcheck_allow_unauthorized 配置值 linkcheck_allowed_redirects 配置值 linkcheck_anchors 配置值 linkcheck_anchors_ignore 配置值 linkcheck_anchors_ignore_for_url 配置值 linkcheck_auth 配置值 linkcheck_exclude_documents 配置值 linkcheck_ignore 配置值 linkcheck_rate_limit_timeout 配置值 linkcheck_report_timeouts_as_broken 配置值 linkcheck_request_headers 配置值 linkcheck_retries 配置值 linkcheck_timeout 配置值 linkcheck_workers 配置值 linkcode_resolve 配置值 链接 automatic literal_emphasis (sphinx.addnodes 中的类) literalinclude (指令) :append: (指令选项) :caption: (指令选项) :class: (指令选项) :dedent: (指令选项) :diff: (指令选项) :emphasize-lines: (指令选项) :encoding: (指令选项) :end-at: (指令选项) :end-before: (指令选项) :force: (指令选项) :language: (指令选项) :lineno-match: (指令选项) :lineno-start: (指令选项) :linenos: (指令选项) :lines: (指令选项) :name: (指令选项) :prepend: (指令选项) :pyobject: (指令选项) :start-after: (指令选项) :start-at: (指令选项) :tab-width: (指令选项) locale_dirs 配置值 log() (sphinx.util.logging.SphinxLoggerAdapter 方法) logo_url (内置变量)

M

:maxdepth: (指令选项) c:alias (指令) cpp:alias (指令) :member-order: (指令选项) autoclass (指令) automodule (指令) :members: (指令选项) autoclass (指令) automodule (指令) mailheader (角色) makevar (角色) man_make_section_directory 配置值 man_pages 配置值 man_show_urls 配置值 manpage (角色) manpages_url 配置值 ManualPageBuilder (sphinx.builders.manpage 中的类) 主文档 master_doc 配置值 master_doc (内置变量) math (指令) :class: (指令选项) :label: (指令选项) :name: (指令选项) :no-wrap: (指令选项) math (角色) math:numref (角色) math_eqref_format 配置值 math_number_all 配置值 math_numfig 配置值 math_numsep 配置值 mathjax2_config 配置值 mathjax3_config 配置值 mathjax_config 配置值 mathjax_options 配置值 mathjax_path 配置值 maximum_signature_line_length 配置值 members (内置变量) menuselection (角色) merge_domaindata() (sphinx.domains.Domain 方法) merge_other() (sphinx.environment.collectors.EnvironmentCollector 方法) MessageCatalogBuilder (sphinx.builders.gettext 中的类) meta (内置变量) metadata (sphinx.environment.BuildEnvironment 属性) metatags (内置变量) methods (内置变量) mimetype (角色)

missing-reference 事件 modindex toctree modindex_common_prefix 配置值 模块 conf docutils.parsers.rst latex 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.latex sphinx.builders.linkcheck sphinx.builders.manpage sphinx.builders.singlehtml sphinx.builders.texinfo sphinx.builders.text sphinx.builders.xml sphinx.directives sphinx.domains sphinx.domains.python sphinx.environment sphinx.environment.collectors sphinx.errors sphinx.ext.apidoc sphinx.ext.autodoc sphinx.ext.autosectionlabel sphinx.ext.autosummary sphinx.ext.coverage sphinx.ext.doctest sphinx.ext.duration 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.testing sphinxcontrib.applehelp sphinxcontrib.devhelp sphinxcontrib.htmlhelp sphinxcontrib.qthelp module (内置变量) modules (内置变量) (sphinx.domains.python.PythonDomain 属性)

N

:name: (指令选项) code-block (指令) digraph (指令) graph (指令) graphviz (指令) index (指令) literalinclude (指令) math (指令) rubric (指令) toctree (指令) :no-index-entry: (指令选项) autoclass (指令) autodata (指令) autofunction (指令) automodule (指令) :no-index: (指令选项) autoclass (指令) autodata (指令) autofunction (指令) automodule (指令) :no-trim-doctest-flags: (指令选项) doctest (指令) testcode (指令) testoutput (指令) :no-value: (指令选项) autodata (指令) :no-wrap: (指令选项) math (指令) :noroot: (指令选项) c:alias (指令) cpp:alias (指令) :nosignatures: (指令选项) autosummary (指令) :numbered: (指令选项) toctree (指令) 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.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.domains.IndexEntry 属性) (sphinx.util.docutils.SphinxRole 属性) (sphinxcontrib.applehelp.AppleHelpBuilder 属性) (sphinxcontrib.devhelp.DevhelpBuilder 属性) (sphinxcontrib.htmlhelp.HTMLHelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性)

napoleon_attr_annotations 配置值 napoleon_custom_sections 配置值 napoleon_google_docstring 配置值 napoleon_include_init_with_doc 配置值 napoleon_include_private_with_doc 配置值 napoleon_include_special_with_doc 配置值 napoleon_numpy_docstring 配置值 napoleon_preprocess_types 配置值 napoleon_type_aliases 配置值 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 配置值 nested_parse_to_nodes() (在 sphinx.util.parsing 模块中) new_serialno() (sphinx.environment.BuildEnvironment 方法) newest_template_mtime() (sphinx.application.TemplateBridge 方法) newsgroup (角色) next (内置变量) nitpick_ignore 配置值 nitpick_ignore_regex 配置值 nitpicky 配置值 note admonition note (指令) note_dependency() (sphinx.environment.BuildEnvironment 方法) note_module() (sphinx.domains.python.PythonDomain 方法) note_object() (sphinx.domains.python.PythonDomain 方法) note_reread() (sphinx.environment.BuildEnvironment 方法) numfig 配置值 numfig_format 配置值 numfig_secnum_depth 配置值 numref (角色)

O

:options: (指令选项) doctest (指令) testoutput (指令) object (指令) object-description-transform 事件 object_types (sphinx.domains.Domain 属性) ObjectDescription (sphinx.directives 中的类) objects (sphinx.domains.python.PythonDomain 属性) objname (内置变量) objtype (内置变量) ObjType (sphinx.domains 中的类)

only (sphinx.addnodes 中的类) (指令) option (指令) (角色) option_emphasise_placeholders 配置值 option_spec (docutils.parsers.rst.Directive 属性) (sphinx.directives.ObjectDescription 属性) optional_arguments (docutils.parsers.rst.Directive 属性) (sphinx.directives.ObjectDescription 属性) options (docutils.parsers.rst.Directive 属性) (sphinx.util.docutils.SphinxRole 属性) out_suffix (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) outdir (sphinx.application.Sphinx 属性)

P

:platform: (指令选项) automodule (指令) py:module (指令) :prepend: (指令选项) literalinclude (指令) :private-members: (指令选项) autoclass (指令) automodule (指令) :pyobject: (指令选项) literalinclude (指令) :pyversion: (指令选项) doctest (指令) page_source_suffix (内置变量) pagename (内置变量) parallel_read_safe (sphinx.util.typing.ExtensionMetadata 属性) parallel_write_safe (sphinx.util.typing.ExtensionMetadata 属性) parents (内置变量) parse_content_to_nodes() (sphinx.util.docutils.SphinxDirective 方法) parse_inline() (sphinx.util.docutils.SphinxDirective 方法) parse_text_to_nodes() (sphinx.util.docutils.SphinxDirective 方法) Parser (sphinx.parsers 中的类) parser (sphinx.environment.BuildEnvironment 属性) path2doc() (sphinx.project.Project 方法) pathto() 内置函数 pending_logging() (在 sphinx.util.logging 模块中) pending_warnings() (在 sphinx.util.logging 模块中) pending_xref (sphinx.addnodes 中的类) pending_xref_condition (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 配置值 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 配置值 project (内置变量) Project (sphinx.project 中的类) project (sphinx.application.Sphinx 属性) (sphinx.environment.BuildEnvironment 属性) project_copyright 配置值 PseudoXMLBuilder (sphinx.builders.xml 中的类) py:attr (角色) py:attribute (指令) :canonical: (指令选项) :type: (指令选项) :value: (指令选项) py:class (指令) :abstract: (指令选项) :canonical: (指令选项) :final: (指令选项) :single-line-parameter-list: (指令选项) :single-line-type-parameter-list: (指令选项) py:class (角色) py:classmethod (指令) py:const (角色) py:currentmodule (指令) py:data (指令) :canonical: (指令选项) :type: (指令选项) :value: (指令选项)

py:data (角色) py:deco (角色) py:decorator (指令) :single-line-parameter-list: (指令选项) :single-line-type-parameter-list: (指令选项) py:decoratormethod (指令) py:exc (角色) py:exception (指令) :final: (指令选项) :single-line-parameter-list: (指令选项) :single-line-type-parameter-list: (指令选项) py:func (角色) py:function (指令) :async: (指令选项) :canonical: (指令选项) :single-line-parameter-list: (指令选项) :single-line-type-parameter-list: (指令选项) py:meth (角色) py:method (指令) :abstract: (指令选项) :abstractmethod: (指令选项) :async: (指令选项) :canonical: (指令选项) :classmethod: (指令选项) :final: (指令选项) :single-line-parameter-list: (指令选项) :single-line-type-parameter-list: (指令选项) :staticmethod: (指令选项) py:mod (角色) py:module (指令) :deprecated: (指令选项) :platform: (指令选项) :synopsis: (指令选项) py:obj (角色) py:property (指令) :abstract: (指令选项) :abstractmethod: (指令选项) :classmethod: (指令选项) :type: (指令选项) py:staticmethod (指令) py:type (指令) :canonical: (指令选项) py:type (角色) pygments_style 配置值 Python 增强提案 PEP 257#what-is-a-docstring PEP 287 PEP 420, [1], [2] PEP 440 PEP 440#version-specifiers PEP 484, [1], [2] PEP 526, [1] PEP 563 PEP 585 PEP 604 PEP 695, [1], [2], [3], [4], [5] PEP 696 PEP 8 python:PYTHONWARNINGS python_display_short_literal_types 配置值 python_maximum_signature_line_length 配置值 python_trailing_comma_in_multi_line_signatures 配置值 python_use_unqualified_type_names 配置值 PythonDomain (sphinx.domains.python 中的类) PyType_GenericAlloc (C 函数)

Q

qthelp_basename 配置值 qthelp_namespace 配置值 qthelp_theme 配置值

qthelp_theme_options 配置值 QtHelpBuilder (sphinxcontrib.qthelp 中的类) qualifier (sphinx.domains.IndexEntry 属性) query() (sphinxcontrib.websupport.search.BaseSearch 方法)

R

:recursive: (指令选项) autosummary (指令) :reversed: (指令选项) toctree (指令) rawtext (sphinx.util.docutils.SphinxRole 属性) read() (sphinx.builders.Builder 方法) read_doc() (sphinx.builders.Builder 方法) ref (角色) ReferenceRole (sphinx.util.docutils 中的类) regexp (角色) relbar() 内置函数 reldelim1 (内置变量) reldelim2 (内置变量) release 配置值 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 属性) (sphinx.directives.ObjectDescription 属性) resolve_any_xref() (sphinx.domains.Domain 方法) resolve_xref() (sphinx.domains.Domain 方法) restore() (sphinx.project.Project 方法)

reStructuredText RFC RFC 2324 RFC 3986 Section 4.4, [1] RFC 6596 RFC 8081 rfc (角色) 角色 role() (sphinx.domains.Domain 方法) roles (sphinx.domains.Domain 属性) 根文档 root_doc 配置值 root_doc (内置变量) rst:dir (角色) rst:directive (指令) rst:directive:option (指令) :type: (指令选项) rst:role (指令) (角色) rst_epilog 配置值 rst_prolog 配置值 rubric (指令) :class: (指令选项) :heading-level: (指令选项) :name: (指令选项) run() (docutils.parsers.rst.Directive 方法) (sphinx.directives.ObjectDescription 方法) (sphinx.transforms.post_transforms.SphinxPostTransform 方法)

S

:show-inheritance: (指令选项) autoclass (指令) automodule (指令) :signatures: (指令选项) autosummary (指令) :single-line-parameter-list: (指令选项) c:function (指令) c:macro (指令) cpp:function (指令) js:class (指令) js:function (指令) js:method (指令) py:class (指令) py:decorator (指令) py:exception (指令) py:function (指令) py:method (指令) :single-line-type-parameter-list: (指令选项) py:class (指令) py:decorator (指令) py:exception (指令) py:function (指令) py:method (指令) :skipif: (指令选项) doctest (指令) testcleanup (指令) testcode (指令) testoutput (指令) testsetup (指令) :sorted: (指令选项) glossary (指令) :special-members: (指令选项) autoclass (指令) automodule (指令) :start-after: (指令选项) literalinclude (指令) :start-at: (指令选项) literalinclude (指令) :staticmethod: (指令选项) py:method (指令) :synopsis: (指令选项) automodule (指令) py:module (指令) samp (角色) script_files (内置变量) 搜索 toctree searchindex_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) sectionauthor (指令) seealso (sphinx.addnodes 中的类) (指令) SerializingHTMLBuilder (sphinxcontrib.serializinghtml 中的类) set_application() (sphinx.parsers.Parser 方法) set_html_assets_policy() (sphinx.application.Sphinx 方法) set_source_info() (sphinx.util.docutils.SphinxDirective 方法) set_translator() (sphinx.application.Sphinx 方法) setup() (sphinx.domains.Domain 方法) setup_extension() (sphinx.application.Sphinx 方法) shorttitle (内置变量) show_authors 配置值 show_source (内置变量) show_warning_types 配置值 sidebar() 内置函数 SIG_ELEMENTS (在 sphinx.addnodes 模块中) SingleFileHTMLBuilder (sphinx.builders.singlehtml 中的类) singlehtml_sidebars 配置值 smartquotes 配置值 smartquotes_action 配置值 smartquotes_excludes 配置值 代码片段 测试 源目录 source-read 事件 source_encoding 配置值 source_suffix 配置值 source_suffix (sphinx.project.Project 属性) 源代码 (指令) sourcename (内置变量) Sphinx (sphinx.application 中的类) sphinx-apidoc 命令行选项 --dry-run --follow-links --force --full --implicit-namespaces --module-first --no-headings --no-toc --private --remove-old --separate --templatedir --tocfile -a -A -d -e -E -f -F -H -l -M -n -o -P -q -R -s -T -t -V sphinx-autogen 命令行选项 --imported-members --remove-old --respect-module-all --suffix --templates -a -i -o -s -t sphinx-build 命令行选项 --builder --color --conf-dir --define --doctree-dir --exception-on-warning --fail-on-warning --fresh-env --help --html-define --isolated --jobs --keep-going --nitpicky --no-color --pdb --quiet --show-traceback --silent --tag --verbose --version --warning-file --write-all -a -A -b -c -C -d -D -E -h -j -M -n -N -P -q -Q -t -T -v -w -W sphinx-quickstart 命令行选项 --author --batchfile --dot --ext-autodoc --ext-coverage --ext-doctest --ext-githubpages --ext-ifconfig --ext-imgmath --ext-intersphinx --ext-mathjax --ext-todo --ext-viewcode --extensions --help --language --makefile --master --no-batchfile --no-makefile --no-sep --no-use-make-mode --project --quiet --release --sep --suffix --templatedir --use-make-mode --version -a -d -h -l -p -q -r -t -v

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.latex 模块 sphinx.builders.linkcheck 模块 sphinx.builders.manpage 模块 sphinx.builders.singlehtml 模块 sphinx.builders.texinfo 模块 sphinx.builders.text 模块 sphinx.builders.xml 模块 sphinx.directives 模块 sphinx.domains 模块 sphinx.domains.python 模块 sphinx.environment 模块 sphinx.environment.collectors 模块 sphinx.errors 模块 sphinx.ext.apidoc 模块 sphinx.ext.autodoc 模块 sphinx.ext.autosectionlabel 模块 sphinx.ext.autosummary 模块 sphinx.ext.coverage 模块 sphinx.ext.doctest 模块 sphinx.ext.duration 模块 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.testing 模块 sphinx_version (内置变量) sphinx_version_tuple (内置变量) sphinxcontrib.applehelp 模块 sphinxcontrib.devhelp 模块 sphinxcontrib.htmlhelp 模块 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 属性) StorageBackend (sphinxcontrib.websupport.storage 中的类) strip_signature_backslash 配置值 styles (内置变量) 替换 全局, [1], [2] subtype (sphinx.domains.IndexEntry 属性) 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.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.htmlhelp.HTMLHelpBuilder 属性) (sphinxcontrib.qthelp.QtHelpBuilder 属性) (sphinxcontrib.serializinghtml.JSONHTMLBuilder 属性) (sphinxcontrib.serializinghtml.PickleHTMLBuilder 属性) supported_linkcode (sphinx.builders.Builder 属性) supported_remote_images (sphinx.builders.Builder 属性) suppress_warnings 配置值

T

:tab-width: (指令选项) literalinclude (指令) :template: (指令选项) autosummary (指令) :titlesonly: (指令选项) toctree (指令) :toctree: (指令选项) autosummary (指令) :trim-doctest-flags: (指令选项) doctest (指令) testcode (指令) testoutput (指令) :type: (指令选项) confval (指令) py:attribute (指令) py:data (指令) py:property (指令) rst:directive:option (指令) 目录 contents tabularcolumns (指令) target (sphinx.util.docutils.ReferenceRole 属性) template_bridge 配置值 TemplateBridge (sphinx.application 中的类) templates_path 配置值 term (角色) testcleanup (指令) :skipif: (指令选项) testcode (指令) :hide: (指令选项) :no-trim-doctest-flags: (指令选项) :skipif: (指令选项) :trim-doctest-flags: (指令选项) 测试 automatic 代码片段 testoutput (指令) :hide: (指令选项) :no-trim-doctest-flags: (指令选项) :options: (指令选项) :skipif: (指令选项) :trim-doctest-flags: (指令选项) testsetup (指令) :skipif: (指令选项) texinfo_appendices 配置值 texinfo_cross_references 配置值 texinfo_documents 配置值 texinfo_domain_indices 配置值 texinfo_elements 配置值 texinfo_no_detailmenu 配置值 texinfo_show_urls 配置值 TexinfoBuilder (sphinx.builders.texinfo 中的类) text (sphinx.util.docutils.SphinxRole 属性) text_add_secnumbers 配置值

text_newlines 配置值 text_secnumber_suffix 配置值 text_sectionchars 配置值 TextBuilder (sphinx.builders.text 中的类) the_answer 配置值 ThemeError tip admonition tip (指令) title (内置变量) (sphinx.util.docutils.ReferenceRole 属性) titles (sphinx.environment.BuildEnvironment 属性) tls_cacerts 配置值 tls_verify 配置值 toc (内置变量) toc_object_entries 配置值 toc_object_entries_show_parents 配置值 toctree genindex modindex 搜索 toctree (内置变量) (sphinx.addnodes 中的类) toctree (指令) :caption: (指令选项) :class: (指令选项) :glob: (指令选项) :hidden: (指令选项) :includehidden: (指令选项) :name: (指令选项) :numbered: (指令选项) :reversed: (指令选项) :titlesonly: (指令选项) today 配置值 today_fmt 配置值 todo (指令) todo-defined 事件 todo_emit_warnings 配置值 todo_include_todos 配置值 todo_link_only 配置值 todolist (指令) token (角色) transform_content() (sphinx.directives.ObjectDescription 方法) translation_progress_classes 配置值 trim_doctest_flags 配置值 trim_footnote_reference_space 配置值

U

:undoc-members: (指令选项) autoclass (指令) automodule (指令) underline (内置变量)

update_username() (sphinxcontrib.websupport.storage.StorageBackend 方法) use_opensearch (内置变量) user_agent 配置值

V

:value: (指令选项) py:attribute (指令) py:data (指令) verbose() (sphinx.util.logging.SphinxLoggerAdapter 方法) version 配置值 version (内置变量) (sphinx.util.typing.ExtensionMetadata 属性) version_info (在 sphinx 模块中) versionadded (指令) versionchanged (指令) versionmodified (sphinx.addnodes 中的类)

versionremoved (指令) VersionRequirementError viewcode-find-source 事件 viewcode-follow-imported 事件 viewcode_enable_epub 配置值 viewcode_follow_imported_members 配置值 viewcode_line_numbers 配置值

W

warn-missing-reference 事件 warning admonition warning (指令) warning() 内置函数

warning() (sphinx.util.logging.SphinxLoggerAdapter 方法) WebSupport (sphinxcontrib.websupport 中的类) write() (sphinx.builders.Builder 方法) write-started 事件 write_doc() (sphinx.builders.Builder 方法) write_doctree() (sphinx.builders.Builder 方法) write_documents() (sphinx.builders.Builder 方法)

X

xml_pretty 配置值

XMLBuilder (sphinx.builders.xml 中的类)