索引

記号

--author sphinx-quickstart コマンドラインオプション --batchfile sphinx-quickstart コマンドラインオプション --builder sphinx-build コマンドラインオプション --color sphinx-build コマンドラインオプション --config-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 メソッド) _toc_entry_name() (sphinx.directives.ObjectDescription メソッド)

A

:abstractmethod: (ディレクティブオプション) py:method (ディレクティブ) py:property (ディレクティブ) :align: (ディレクティブオプション) digraph (ディレクティブ) graph (ディレクティブ) graphviz (ディレクティブ) :alt: (ディレクティブオプション) digraph (ディレクティブ) graph (ディレクティブ) graphviz (ディレクティブ) :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_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 メソッド) 追加済み バージョン 注意 注意 注意 危険 エラー ヒント 重要 注意 ヒント 警告 admonition (ディレクティブ) 注意書き after_content() (sphinx.directives.ObjectDescription メソッド) allow_parallel (sphinx.builders.Builder 属性) anchor (sphinx.domains.IndexEntry 属性) any (ロール) 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 (ディレクティブ) attributes (組み込み変数) author 設定値 autoattribute (ディレクティブ) autoclass (ディレクティブ) autoclass_content 設定値 autodata (ディレクティブ) autodecorator (ディレクティブ) autodoc-before-process-signature イベント autodoc-process-bases イベント autodoc-process-docstring イベント autodoc-process-signature イベント autodoc-skip-member イベント autodoc_class_signature 設定値 autodoc_default_flags 設定値 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_warningiserror 設定値 autoexception (ディレクティブ) autofunction (ディレクティブ) 自動 ドキュメント リンク テスト automethod (ディレクティブ) automodule (ディレクティブ) :members: (ディレクティブオプション) :private-members: (ディレクティブオプション) :special-members: (ディレクティブオプション) :undoc-members: (ディレクティブオプション) autoproperty (ディレクティブ) autosectionlabel_maxdepth 設定値 autosectionlabel_prefix_document 設定値 autosummary (ディレクティブ) 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_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: (ディレクティブオプション) code-block (ディレクティブ) digraph (ディレクティブ) graph (ディレクティブ) graphviz (ディレクティブ) toctree (ディレクティブ) :class: (ディレクティブオプション) code-block (ディレクティブ) digraph (ディレクティブ) graph (ディレクティブ) graphviz (ディレクティブ) 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 (ディレクティブ) centered (ディレクティブ) 変更点 バージョン 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-block (ディレクティブ) :caption: (ディレクティブオプション) :class: (ディレクティブオプション) :dedent: (ディレクティブオプション) :emphasize-lines: (ディレクティブオプション) :force: (ディレクティブオプション) :lineno-start: (ディレクティブオプション) :linenos: (ディレクティブオプション) :name: （ディレクティブオプション） codeauthor （ディレクティブ） command （ロール） 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 イベント ConfigError 設定ディレクトリ 設定値 add_function_parentheses add_module_names 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_flags 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_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_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_timeout javascript_maximum_signature_line_length 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_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 メソッド） CustomList （C++型） cut_lines() （sphinx.ext.autodocモジュール内）

D

:dedent: (ディレクティブオプション) code-block (ディレクティブ) :default: （ディレクティブオプション） confval （ディレクティブ） :deprecated: （ディレクティブオプション） py:module （ディレクティブ） 危険 注意 danger （ディレクティブ） dangling_warnings （sphinx.domains.Domain 属性） data （sphinx.domains.Domain 属性） data_version （sphinx.domains.Domain 属性） debug() （sphinx.util.logging.SphinxLoggerAdapter メソッド） default domain role default-domain （ディレクティブ） default_priority （sphinx.transforms.post_transforms.images.ImageConverter 属性） default_role 設定値 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 属性） docnames （sphinx.project.Project 属性） docstitle （組み込み変数） docstring doctest （ディレクティブ） 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 属性） ドキュメント名 ドキュメント 自動 docutils.parsers.rst module docutils_version_info （組み込み変数） domain default Domain （sphinx.domains内のクラス） download （ロール） download_reference （sphinx.addnodes内のクラス） DummyBuilder （sphinx.builders.dummy内のクラス）

E

:emphasize-lines: (ディレクティブオプション) code-block (ディレクティブ) 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 属性） environment 環境変数 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 （ディレクティブ） error() （sphinx.util.logging.SphinxLoggerAdapter メソッド） escape() 組み込み関数 イベント autodoc-before-process-signature autodoc-process-bases autodoc-process-docstring autodoc-process-signature autodoc-skip-member ビルド完了 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 書き込み開始 EventManager (sphinx.events 内のクラス) events (sphinx.builders.Builder 属性) （sphinx.environment.BuildEnvironment 属性） 例 コード 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 (ディレクティブ) 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 (ディレクティブ) 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_options 設定値 highlightlang (sphinx.addnodes 内のクラス) ヒント 注意 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_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

:includehidden: (ディレクティブオプション) toctree (ディレクティブ) 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 (ディレクティブ) バージョン 追加済み 変更点 削除済み

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 (ディレクティブ) 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_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 設定値 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 (ディレクティブ) :layout: （ディレクティブオプション） digraph (ディレクティブ) graph (ディレクティブ) graphviz (ディレクティブ) :lineno-start: (ディレクティブオプション) code-block (ディレクティブ) :linenos: (ディレクティブオプション) code-block (ディレクティブ) :linenothreshold: (ディレクティブオプション) highlight (ディレクティブ) label (sphinx.domains.Domain 属性) language 設定値 language (組み込み変数) last_updated (組み込み変数) latex module 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 設定値 リンク 自動 literal_emphasis (sphinx.addnodes 内のクラス) literalinclude (ディレクティブ) locale_dirs 設定値 log() (sphinx.util.logging.SphinxLoggerAdapter メソッド) logo_url (組み込み変数)

M

:maxdepth: (ディレクティブオプション) c:alias (ディレクティブ) cpp:alias （ディレクティブ） :members: (ディレクティブオプション) 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: （ディレクティブオプション） :nowrap: (ディレクティブオプション) 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 設定値 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.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 (ディレクティブ) math (ディレクティブ) rubric (ディレクティブ) toctree (ディレクティブ) :noroot: (ディレクティブオプション) c:alias (ディレクティブ) cpp:alias （ディレクティブ） :nowrap: (ディレクティブオプション) math (ディレクティブ) :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 (ディレクティブ) 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

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: (ディレクティブオプション) py:module （ディレクティブ） :private-members: (ディレクティブオプション) automodule (ディレクティブ) 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 (ディレクティブ) :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: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 (ディレクティブ) :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 (ディレクティブ) :abstractmethod: (ディレクティブオプション) :classmethod: (ディレクティブオプション) :type: （ディレクティブオプション） py:staticmethod (ディレクティブ) py:type (ディレクティブ) :canonical: (ディレクティブオプション) py:type (ロール) pygments_style 設定値 Python Enhancement Proposals PEP 257#what-is-a-docstring PEP 287 PEP 420 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_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

: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 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

: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 (ディレクティブ) :sorted: (ディレクティブオプション) glossary (ディレクティブ) :special-members: (ディレクティブオプション) automodule (ディレクティブ) :staticmethod: (ディレクティブオプション) py:method (ディレクティブ) :synopsis: (ディレクティブオプション) py:module （ディレクティブ） samp (ロール) script_files (組み込み変数) 検索 toctree searchindex_filename (sphinxcontrib.serializinghtml.SerializingHTMLBuilder 属性) sectionauthor (ディレクティブ) seealso (sphinx.addnodes のクラス) （ディレクティブ） SerializingHTMLBuilder (sphinxcontrib.serializinghtml のクラス) set_application() (sphinx.parsers.Parser メソッド) 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 --config-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.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.jsmath 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.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 設定値 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_remote_images (sphinx.builders.Builder 属性) suppress_warnings 設定値

T

:titlesonly: (ディレクティブオプション) toctree (ディレクティブ) :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 (ディレクティブ) testcode (ディレクティブ) テスト 自動 スニペット testoutput (ディレクティブ) testsetup (ディレクティブ) 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 (ディレクティブ) 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: (ディレクティブオプション) 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 (ディレクティブ) warning() 組み込み関数

warning() (sphinx.util.logging.SphinxLoggerAdapter メソッド) WebSupport (sphinxcontrib.websupport のクラス) write() (sphinx.builders.Builder メソッド) 書き込み開始 イベント write_doc() (sphinx.builders.Builder メソッド) write_doctree() (sphinx.builders.Builder メソッド)

X

xml_pretty 設定値

XMLBuilder (sphinx.builders.xml のクラス)