索引

符號

--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 （角色） add() (sphinx.events.EventManager 的方法) add_autodoc_attrgetter() (sphinx.application.Sphinx 的方法) add_autodocumenter() (sphinx.application.Sphinx 的方法) add_builder() (sphinx.application.Sphinx 的方法) 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_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_linkcode_domain() (於 sphinx.ext.linkcode 模組中) add_message_catalog() (sphinx.application.Sphinx 的方法) add_module_names configuration value add_node() (sphinx.application.Sphinx 的方法) 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_static_dir() (sphinx.application.Sphinx 的方法) add_target_and_index() (sphinx.directives.ObjectDescription 的方法) add_transform() (sphinx.application.Sphinx 的方法) added in version 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 configuration value apidoc_exclude_patterns configuration value apidoc_follow_links configuration value apidoc_implicit_namespaces configuration value apidoc_include_private configuration value apidoc_max_depth configuration value apidoc_module_first configuration value apidoc_modules configuration value apidoc_no_headings configuration value apidoc_separate_modules configuration value 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 的屬性) attention admonition attention （指令） attributes (內建變數) author configuration value 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 configuration value autodata （指令） :annotation: （指令選項） :no-index-entry: （指令選項） :no-index: （指令選項） :no-value: （指令選項） autodecorator （指令） autodoc-before-process-signature event autodoc-process-bases event autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_class_signature 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_preserve_defaults configuration value autodoc_type_aliases configuration value autodoc_typehints configuration value autodoc_typehints_description_target configuration value autodoc_typehints_format configuration value autodoc_use_legacy_class_based configuration value autodoc_use_type_comments configuration value autodoc_warningiserror configuration value autoexception （指令） autofunction （指令） :no-index-entry: （指令選項） :no-index: （指令選項） autolink （角色） automatic documentation, [1] linking testing 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 configuration value autosectionlabel_prefix_document configuration value autosummary （指令） :caption: （指令選項） :class: （指令選項） :nosignatures: （指令選項） :recursive: （指令選項） :signatures: （指令選項） :template: （指令選項） :toctree: （指令選項） autosummary_context configuration value autosummary_filename_map configuration value autosummary_generate configuration value autosummary_generate_overwrite configuration value autosummary_ignore_module_all configuration value autosummary_imported_members configuration value autosummary_mock_imports configuration value autotype （指令） :no-index-entry: （指令選項） :no-index: （指令選項） 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 的方法) build-finished event build_all() (sphinx.builders.Builder 的方法) build_specific() (sphinx.builders.Builder 的方法) build_update() (sphinx.builders.Builder 的方法) BuildEnvironment (sphinx.environment 中的類別)

Builder (sphinx.builders 中的類別) builder (內建變數) builder-inited event built-in function 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:enum （角色） c:enumerator （指令） c:enumerator （角色） c:expr （角色） c:func （角色） c:function （指令） :single-line-parameter-list: （指令選項） c:macro （指令） :single-line-parameter-list: （指令選項） c:macro （角色） c:member （指令） c:member （角色） c:namespace （指令） c:namespace-pop （指令） c:namespace-push （指令） c:struct （指令） c:struct （角色） c:texpr （角色） c:type （指令） c:type （角色） c:union （指令） c:union （角色） c:var （指令） c:var （角色） c_extra_keywords configuration value c_id_attributes configuration value c_maximum_signature_line_length configuration value c_paren_attributes configuration value category (sphinx.errors.SphinxError 的屬性) caution admonition caution （指令） 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 （指令） 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 module 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 event ConfigError configuration value 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_legacy_class_based 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_fail_fast doctest_global_cleanup doctest_global_setup doctest_path doctest_show_successes doctest_test_doctest_blocks duration_limit duration_n_slowest duration_print_slowest duration_print_total duration_write_json 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_case_insensitive_urls 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 mathjax4_config mathjax_config mathjax_config_path 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 table of conversion_rules (sphinx.transforms.post_transforms.images.ImageConverter 的屬性) convert() (sphinx.transforms.post_transforms.images.ImageConverter 的方法) copy_assets() (sphinx.builders.Builder 的方法) copyright configuration value copyright (內建變數) coverage_c_path configuration value coverage_c_regexes configuration value coverage_ignore_c_items configuration value coverage_ignore_classes configuration value coverage_ignore_functions configuration value coverage_ignore_modules configuration value coverage_ignore_pyobjects configuration value coverage_modules configuration value coverage_show_missing_items configuration value coverage_skip_undoc_in_source configuration value coverage_statistics_to_report configuration value coverage_statistics_to_stdout configuration value coverage_write_headline configuration value CoverageBuilder (sphinx.ext.coverage 中的類別) cpp:alias （指令） :maxdepth: （指令選項） :noroot: （指令選項） cpp:any （角色） cpp:class （指令） cpp:class （角色） cpp:concept （指令） cpp:concept （角色） cpp:enum （指令） cpp:enum （角色） cpp:enum-class （指令） cpp:enum-struct （指令） cpp:enumerator （指令） cpp:enumerator （角色） cpp:expr （角色） cpp:func （角色） cpp:function （指令） :single-line-parameter-list: （指令選項） cpp:member （指令） cpp:member （角色） cpp:namespace （指令） cpp:namespace-pop （指令） cpp:namespace-push （指令） cpp:struct （指令） cpp:struct （角色） cpp:texpr （角色） cpp:type （指令） cpp:type （角色） cpp:union （指令） cpp:var （指令） cpp:var （角色） cpp_id_attributes configuration value cpp_index_common_prefix configuration value cpp_maximum_signature_line_length configuration value cpp_paren_attributes configuration value critical() (sphinx.util.logging.SphinxLoggerAdapter 的方法) current_document (sphinx.environment.BuildEnvironment 的屬性) CustomList (C++ type) 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 角色（role） 領域（domain） default-domain （指令） default_domain (sphinx.environment.BuildEnvironment.current_document 的屬性) default_priority (sphinx.transforms.post_transforms.images.ImageConverter 的屬性) default_role configuration value default_role (sphinx.environment.BuildEnvironment.current_document 的屬性) default_translator_class (sphinx.builders.Builder 的屬性) 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 (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 configuration value doctest_fail_fast configuration value doctest_global_cleanup configuration value doctest_global_setup configuration value doctest_path configuration value doctest_show_successes configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event doctreedir (sphinx.application.Sphinx 的屬性) (sphinx.environment.BuildEnvironment 的屬性) document name documentation automatic, [1] generate generation docutils.parsers.rst module docutils_version_info (內建變數) Domain (sphinx.domains 中的類別) download （角色） download_reference (sphinx.addnodes 中的類別) DummyBuilder (sphinx.builders.dummy 中的類別) duration_limit configuration value duration_n_slowest configuration value duration_print_slowest configuration value duration_print_total configuration value duration_write_json configuration value

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() built-in function env (sphinx.parsers.Parser 的特性) (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-get-updated event env-merge-info event env-purge-doc event env-updated event env_version (sphinx.util.typing.ExtensionMetadata 的屬性) EnvironmentCollector (sphinx.environment.collectors 中的類別) envvar （指令） 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 admonition error （指令） error() (sphinx.util.logging.SphinxLoggerAdapter 的方法) escape() built-in function event 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 的屬性) examples code exceptions (內建變數) exclude_patterns configuration value extension ExtensionError, [1] ExtensionMetadata (sphinx.util.typing 中的類別) extensions configuration value external （角色） extlinks configuration value extlinks_detect_hardcoded_links configuration value extra (sphinx.domains.IndexEntry 的屬性)

F

:final: （指令選項） py:class （指令） py:exception （指令） py:method （指令） :force: （指令選項） code-block （指令） highlight （指令） literalinclude （指令） favicon_url (內建變數) figure_language_filename configuration value file （角色） file_suffix (內建變數) final_argument_whitespace (docutils.parsers.rst.Directive 的屬性) (sphinx.directives.ObjectDescription 的屬性) finish() (sphinx.builders.Builder 的方法) 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 documentation generate() (sphinx.domains.Index 的方法) generation documentation genindex toctree 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_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 configuration value gettext_allow_fuzzy_translations 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 中的類別) glossary （指令） :sorted: （指令選項） graph （指令） :align: （指令選項） :alt: （指令選項） :caption: （指令選項） :class: （指令選項） :layout: （指令選項） :name: （指令選項） graphviz （指令） :align: （指令選項） :alt: （指令選項） :caption: （指令選項） :class: （指令選項） :layout: （指令選項） :name: （指令選項） graphviz_dot configuration value graphviz_dot_args configuration value graphviz_output_format configuration value guilabel （角色）

H

:heading-level: （指令選項） rubric （指令） :hidden: （指令選項） toctree （指令） :hide: （指令選項） doctest （指令） testcode （指令） testoutput （指令） handle_signature() (sphinx.directives.ObjectDescription 的方法) has_content (docutils.parsers.rst.Directive 的屬性) (sphinx.directives.ObjectDescription 的屬性) has_explicit_title (sphinx.util.docutils.ReferenceRole 的屬性) has_source (內建變數) hasdoc() built-in function highlight （指令） :force: （指令選項） :linenothreshold: （指令選項） highlight_language configuration value highlight_language (sphinx.environment.BuildEnvironment.current_document 的屬性) highlight_options configuration value highlightlang (sphinx.addnodes 中的類別) hint admonition hint （指令） hlist （指令） :columns: （指令選項） html-collect-pages event html-page-context event html_additional_pages configuration value html_baseurl configuration value html_codeblock_linenos_style 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_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_last_updated_use_utc configuration value

html_link_suffix configuration value html_logo configuration value html_math_renderer configuration value html_output_encoding configuration value html_permalinks configuration value html_permalinks_icon 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_search_summary 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 htmlhelp_basename configuration value htmlhelp_file_suffix configuration value htmlhelp_link_suffix configuration value HTMLHelpBuilder (sphinxcontrib.htmlhelp 中的類別)

I

:ignore-module-all: （指令選項） automodule （指令） :imported-members: （指令選項） automodule （指令） :include-subclasses: （指令選項） inheritance-diagram （指令） :includehidden: （指令選項） toctree （指令） :inherited-members: （指令選項） autoclass （指令） 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_embed 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 的屬性) important admonition important （指令） in version added changes removed

include-read event include_patterns configuration value 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 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 模組中) initial_data (sphinx.domains.Domain 的屬性) inliner (sphinx.util.docutils.SphinxRole 的屬性) intersphinx_cache_limit configuration value intersphinx_disabled_reftypes configuration value intersphinx_mapping configuration value intersphinx_resolve_self 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

javascript_maximum_signature_line_length configuration value javascript_trailing_comma_in_multi_line_signatures configuration value js:attr （角色） js:attribute （指令） js:class （指令） :single-line-parameter-list: （指令選項） js:class （角色） js:data （指令） js:data （角色）

js:func （角色） js:function （指令） :single-line-parameter-list: （指令選項） js:meth （角色） js:method （指令） :single-line-parameter-list: （指令選項） js:mod （角色） js:module （指令） jsmath_path configuration value JSONHTMLBuilder (sphinxcontrib.serializinghtml 中的類別)

K

kbd （角色） keep_warnings configuration value

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 configuration value language (內建變數) last_updated (內建變數) latex module 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_table_style configuration value latex_theme configuration value latex_theme_options configuration value latex_theme_path 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 的屬性)

linkcheck-process-uri event linkcheck_allow_unauthorized configuration value linkcheck_allowed_redirects configuration value linkcheck_anchors configuration value linkcheck_anchors_ignore configuration value linkcheck_anchors_ignore_for_url configuration value linkcheck_auth configuration value linkcheck_case_insensitive_urls configuration value linkcheck_exclude_documents configuration value linkcheck_ignore configuration value linkcheck_rate_limit_timeout configuration value linkcheck_report_timeouts_as_broken configuration value linkcheck_request_headers 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 （指令） :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 configuration value 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 configuration value man_pages configuration value man_show_urls configuration value manpage （角色） manpages_url configuration value ManualPageBuilder (sphinx.builders.manpage 中的類別) master document master_doc configuration value master_doc (內建變數) math （指令） :class: （指令選項） :label: （指令選項） :name: （指令選項） :no-wrap: （指令選項） math （角色） math:numref （角色） math_eqref_format configuration value math_number_all configuration value math_numfig configuration value math_numsep configuration value mathjax2_config configuration value mathjax3_config configuration value mathjax4_config configuration value mathjax_config configuration value mathjax_config_path configuration value mathjax_options configuration value mathjax_path configuration value maximum_signature_line_length configuration value 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 event modindex toctree modindex_common_prefix configuration value module 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.events 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.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.jsmath 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 （指令） autotype （指令） :no-index: （指令選項） autoclass （指令） autodata （指令） autofunction （指令） automodule （指令） autotype （指令） :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 configuration value napoleon_custom_sections configuration value 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_preprocess_types configuration value napoleon_type_aliases 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 nested_parse_to_nodes() (於 sphinx.util.parsing 模組中) new_serialno() (sphinx.environment.BuildEnvironment 的方法) newest_template_mtime() (sphinx.application.TemplateBridge 的方法) newsgroup （角色） next (內建變數) nitpick_ignore configuration value nitpick_ignore_regex configuration value nitpicky configuration value 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 configuration value numfig_format configuration value numfig_secnum_depth configuration value numref （角色）

O

:options: （指令選項） doctest （指令） testoutput （指令） object （指令） object-description-transform event object_types (sphinx.domains.Domain 的屬性) ObjectDescription (sphinx.directives 中的類別) objects (sphinx.domains.python.PythonDomain 的屬性) objname (內建變數) ObjType (sphinx.domains 中的類別) objtype (內建變數) only (sphinx.addnodes 中的類別)

only （指令） option （指令） option （角色） option_emphasise_placeholders configuration value 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.environment.BuildEnvironment 的屬性) Parser (sphinx.parsers 中的類別) path2doc() (sphinx.project.Project 的方法) pathto() built-in function pending_logging() (於 sphinx.util.logging 模組中) pending_warnings() (於 sphinx.util.logging 模組中) pending_xref (sphinx.addnodes 中的類別) pending_xref_condition (sphinx.addnodes 中的類別) pep （角色） PickleHTMLBuilder (sphinxcontrib.serializinghtml 中的類別) prefixed_warnings() (於 sphinx.util.logging 模組中) prepare_writing() (sphinx.builders.Builder 的方法) prev (內建變數) primary_domain configuration value process_doc() (sphinx.domains.Domain 的方法) (sphinx.environment.collectors.EnvironmentCollector 的方法) process_field_xref() (sphinx.domains.Domain 的方法) production (sphinx.addnodes 中的類別) productionlist (sphinx.addnodes 中的類別) productionlist （指令） program （指令） program （角色） project configuration value project (sphinx.application.Sphinx 的屬性) (sphinx.environment.BuildEnvironment 的屬性) Project (sphinx.project 中的類別) project (內建變數) project_copyright configuration value 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 configuration value Python Enhancement Proposals 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], [6], [7] PEP 696 PEP 8 python:PYTHONWARNINGS python_display_short_literal_types configuration value python_maximum_signature_line_length configuration value python_trailing_comma_in_multi_line_signatures configuration value python_use_unqualified_type_names configuration value PythonDomain (sphinx.domains.python 中的類別) PyType_GenericAlloc (C function)

Q

qthelp_basename configuration value qthelp_namespace configuration value qthelp_theme configuration value

qthelp_theme_options configuration value QtHelpBuilder (sphinxcontrib.qthelp 中的類別) qualifier (sphinx.domains.IndexEntry 的屬性)

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() built-in function reldelim1 (內建變數) reldelim2 (內建變數) release configuration value release (內建變數) relfn2path() (sphinx.environment.BuildEnvironment 的方法) rellinks (內建變數) removed in version 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 document root_doc configuration value root_doc (內建變數) rst:dir （角色） rst:directive （指令） rst:directive:option （指令） :type: （指令選項） rst:role （指令） rst:role （角色） rst_epilog configuration value rst_prolog configuration value 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 (內建變數) search toctree searchindex_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 的屬性) sectionauthor （指令） seealso (sphinx.addnodes 中的類別) seealso （指令） 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 configuration value show_source (內建變數) show_warning_types configuration value sidebar() built-in function SIG_ELEMENTS (於 sphinx.addnodes 模組中) SingleFileHTMLBuilder (sphinx.builders.singlehtml 中的類別) singlehtml_sidebars configuration value smartquotes configuration value smartquotes_action configuration value smartquotes_excludes configuration value snippets testing source-read event source_encoding configuration value source_suffix configuration value source_suffix (sphinx.project.Project 的屬性) sourcecode sourcecode （指令） 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 module sphinx.application module sphinx.builders module sphinx.builders.changes module sphinx.builders.dirhtml module sphinx.builders.dummy module sphinx.builders.epub3 module sphinx.builders.gettext module sphinx.builders.html module sphinx.builders.latex module sphinx.builders.linkcheck module sphinx.builders.manpage module sphinx.builders.singlehtml module sphinx.builders.texinfo module sphinx.builders.text module sphinx.builders.xml module sphinx.directives module sphinx.domains module sphinx.domains.python module sphinx.environment module sphinx.environment.collectors module sphinx.errors module sphinx.events module sphinx.ext.apidoc module sphinx.ext.autodoc module sphinx.ext.autosectionlabel module sphinx.ext.autosummary module sphinx.ext.coverage module sphinx.ext.doctest module sphinx.ext.duration module sphinx.ext.extlinks module sphinx.ext.githubpages module sphinx.ext.graphviz module sphinx.ext.ifconfig module sphinx.ext.imgconverter module sphinx.ext.imgmath module sphinx.ext.inheritance_diagram module sphinx.ext.intersphinx module sphinx.ext.linkcode module sphinx.ext.mathbase module sphinx.ext.mathjax module sphinx.ext.napoleon module sphinx.ext.todo module sphinx.ext.viewcode module sphinx.parsers module sphinx.testing module sphinx_version (內建變數) sphinx_version_tuple (內建變數) sphinxcontrib.applehelp module sphinxcontrib.devhelp module sphinxcontrib.htmlhelp module sphinxcontrib.jsmath module sphinxcontrib.qthelp module 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 configuration value styles (內建變數) substitutions global, [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 configuration value

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 （指令） table of contents tabularcolumns （指令） target (sphinx.util.docutils.ReferenceRole 的屬性) template_bridge configuration value TemplateBridge (sphinx.application 中的類別) templates_path configuration value term （角色） testcleanup （指令） :skipif: （指令選項） testcode （指令） :hide: （指令選項） :no-trim-doctest-flags: （指令選項） :skipif: （指令選項） :trim-doctest-flags: （指令選項） testing automatic snippets testoutput （指令） :hide: （指令選項） :no-trim-doctest-flags: （指令選項） :options: （指令選項） :skipif: （指令選項） :trim-doctest-flags: （指令選項） testsetup （指令） :skipif: （指令選項） texinfo_appendices configuration value texinfo_cross_references 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 中的類別) the_answer configuration value ThemeError tip admonition tip （指令） title (sphinx.util.docutils.ReferenceRole 的屬性) (內建變數) titles (sphinx.environment.BuildEnvironment 的屬性) tls_cacerts configuration value tls_verify configuration value toc (內建變數) toc_object_entries configuration value toc_object_entries_show_parents configuration value toctree genindex modindex search toctree (sphinx.addnodes 中的類別) (內建變數) toctree （指令） :caption: （指令選項） :class: （指令選項） :glob: （指令選項） :hidden: （指令選項） :includehidden: （指令選項） :name: （指令選項） :numbered: （指令選項） :reversed: （指令選項） :titlesonly: （指令選項） today configuration value 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 （角色） transform_content() (sphinx.directives.ObjectDescription 的方法) translation_progress_classes configuration value trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

:undoc-members: （指令選項） autoclass （指令） automodule （指令）

underline (內建變數) use_opensearch (內建變數) user_agent configuration value

V

:value: （指令選項） py:attribute （指令） py:data （指令） verbose() (sphinx.util.logging.SphinxLoggerAdapter 的方法) version configuration value version (sphinx.util.typing.ExtensionMetadata 的屬性) (內建變數) version-added （指令） version-changed （指令） version-deprecated （指令） version-removed （指令） version_info (於 sphinx 模組中) versionadded （指令）

versionchanged （指令） versionmodified (sphinx.addnodes 中的類別) versionremoved （指令） VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub configuration value viewcode_follow_imported_members configuration value viewcode_line_numbers configuration value

W

warn-missing-reference event warning admonition warning （指令） warning() built-in function

warning() (sphinx.util.logging.SphinxLoggerAdapter 的方法) WebSupport (sphinxcontrib.websupport 中的類別) write() (sphinx.builders.Builder 的方法) write-started event write_doc() (sphinx.builders.Builder 的方法) write_doctree() (sphinx.builders.Builder 的方法) write_documents() (sphinx.builders.Builder 的方法)

X

xml_pretty configuration value

XMLBuilder (sphinx.builders.xml 中的類別)

來

來源目錄（source directory）

建

建置器（builder）

指

指示詞（directive）

物

物件（object）

環

環境變數 python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS

環境（environment）

組

組態目錄（configuration directory）

角

角色（role）

領

領域（domain） default