索引

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

---

A

abbr role 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_description_unit() (sphinx.application.Sphinx のメソッド) add_directive() (sphinx.application.Sphinx のメソッド) add_event() (sphinx.application.Sphinx のメソッド) add_function_parentheses configuration value add_generic_role() (sphinx.application.Sphinx のメソッド) add_javascript() (sphinx.application.Sphinx のメソッド) add_lexer() (sphinx.application.Sphinx のメソッド) add_module_names configuration value add_node() (sphinx.application.Sphinx のメソッド) add_role() (sphinx.application.Sphinx のメソッド) add_transform() (sphinx.application.Sphinx のメソッド) attr role attribute directive autoattribute directive autoclass directive

autoclass_content configuration value autodata directive autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_member_order configuration value autoexception directive autofunction directive automatic linking automethod directive automodule directive autosummary directive autosummary_generate configuration value

B

between() (sphinx.ext.autodoc モジュール) build() (sphinx.builders.Builder のメソッド) build-finished event build_all() (sphinx.builders.Builder のメソッド) build_specific() (sphinx.builders.Builder のメソッド)

build_update() (sphinx.builders.Builder のメソッド) Builder (sphinx.builders のクラス) builder (組み込み変数) builder-inited event

C

cdata role centered directive cfunc role cfunction directive changes in version ChangesBuilder (sphinx.builders.changes のクラス) CheckExternalLinksBuilder (sphinx.builders.linkcheck のクラス) class directive role class (sphinx.ext.autosummary モジュール) classes (sphinx.ext.autosummary モジュール) classmethod directive cmacro directive role cmdoption directive cmember directive code examples command role compile() (組み込み関数), [1] conf (モジュール) configuration value add_function_parentheses add_module_names autoclass_content autodoc_member_order autosummary_generate copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules default_role doctest_global_setup doctest_path doctest_test_doctest_blocks exclude_dirnames exclude_dirs exclude_trees extensions graphviz_dot graphviz_dot_args highlight_language html_add_permalinks html_additional_pages html_copy_source html_favicon html_file_suffix html_last_updated_fmt html_link_suffix html_logo html_output_encoding html_short_title html_show_copyright html_show_sourcelink html_show_sphinx html_sidebars html_split_index html_static_path html_style html_theme html_theme_options html_theme_path html_title html_translator_class html_use_index html_use_modindex html_use_opensearch html_use_smartypants htmlhelp_basename inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_mapping jsmath_path keep_warnings language latex_additional_files latex_appendices latex_docclass latex_documents latex_elements latex_font_size latex_logo latex_paper_size latex_preamble latex_use_modindex latex_use_parts locale_dirs master_doc modindex_common_prefix pngmath_dvipng pngmath_dvipng_args pngmath_latex pngmath_latex_args pngmath_latex_preamble pngmath_use_preview project pygments_style release rst_epilog show_authors source_encoding source_suffix template_bridge templates_path today today_fmt todo_include_todos trim_doctest_flags trim_footnote_reference_space unused_docs version

connect() (sphinx.application.Sphinx のメソッド) const role contents table of copyright configuration value copyright (組み込み変数) coverage_c_path configuration value coverage_c_regexes configuration value coverage_ignore_c_items configuration value coverage_ignore_classes configuration value coverage_ignore_functions configuration value coverage_ignore_modules configuration value CoverageBuilder (sphinx.ext.coverage のクラス) ctype directive role currentmodule directive cut_lines() (sphinx.ext.autodoc モジュール) cvar directive

D

data directive role default_role configuration value describe directive DevhelpBuilder (sphinx.builders.devhelp のクラス) dfn role digraph directive directive attribute autoattribute autoclass autodata autoexception autofunction automethod automodule autosummary centered cfunction class classmethod cmacro cmdoption cmember ctype currentmodule cvar data describe digraph doctest envvar exception function glossary graph graphviz hlist ifconfig index inheritance-diagram literalinclude math method module moduleauthor note only productionlist program rubric sectionauthor seealso staticmethod tabularcolumns testcode testoutput testsetup toctree todo todolist versionadded versionchanged warning

DirectoryHTMLBuilder (sphinx.builders.html のクラス) disconnect() (sphinx.application.Sphinx のメソッド) doc role docstitle (組み込み変数) docstring doctest directive doctest_global_setup configuration value doctest_path configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event download role

E

embedded (組み込み変数) emit() (sphinx.application.Sphinx のメソッド) emit_firstresult() (sphinx.application.Sphinx のメソッド) env-purge-doc event env-updated event envvar directive role eq role event autodoc-process-docstring autodoc-process-signature autodoc-skip-member build-finished builder-inited doctree-read doctree-resolved env-purge-doc env-updated missing-reference page-context source-read

examples code exc role exception directive exceptions (sphinx.ext.autosummary モジュール) exclude_dirnames configuration value exclude_dirs configuration value exclude_trees configuration value ExtensionError extensions configuration value

F

favicon (組み込み変数) file role file_suffix (組み込み変数) finish() (sphinx.builders.Builder のメソッド) fullname (sphinx.ext.autosummary モジュール)

func role function directive functions (sphinx.ext.autosummary モジュール)

G

get_outdated_docs() (sphinx.builders.Builder のメソッド) get_relative_uri() (sphinx.builders.Builder のメソッド) get_target_uri() (sphinx.builders.Builder のメソッド) globalcontext_filename (sphinx.builders.html.SerializingHTMLBuilder の属性) glossary directive graph directive graphviz directive

graphviz_dot configuration value graphviz_dot_args configuration value guilabel role

H

has_source (組み込み変数) hasdoc() (組み込み関数) highlight_language configuration value hlist directive html_add_permalinks configuration value html_additional_pages configuration value html_copy_source configuration value html_favicon configuration value html_file_suffix configuration value html_last_updated_fmt configuration value html_link_suffix configuration value html_logo configuration value html_output_encoding configuration value html_short_title configuration value html_show_copyright configuration value html_show_sourcelink configuration value html_show_sphinx configuration value

html_sidebars configuration value html_split_index configuration value html_static_path configuration value html_style configuration value html_theme configuration value html_theme_options configuration value html_theme_path configuration value html_title configuration value html_translator_class configuration value html_use_index configuration value html_use_modindex configuration value html_use_opensearch configuration value html_use_smartypants configuration value htmlhelp_basename configuration value HTMLHelpBuilder (sphinx.builders.htmlhelp のクラス)

I

ifconfig directive implementation (sphinx.builders.html.SerializingHTMLBuilder の属性) in version changes index directive inheritance-diagram directive inheritance_edge_attrs configuration value

inheritance_graph_attrs configuration value inheritance_node_attrs configuration value init() (sphinx.application.TemplateBridge のメソッド) (sphinx.builders.Builder のメソッド) intersphinx_cache_limit configuration value intersphinx_mapping configuration value

J

jsmath_path configuration value

JSONHTMLBuilder (sphinx.builders.html のクラス)

K

kbd role keep_warnings configuration value

keyword role

L

language configuration value last_updated (組み込み変数) latex_additional_files configuration value latex_appendices configuration value latex_docclass configuration value latex_documents configuration value latex_elements configuration value latex_font_size configuration value latex_logo configuration value latex_paper_size configuration value

latex_preamble configuration value latex_use_modindex configuration value latex_use_parts configuration value LaTeXBuilder (sphinx.builders.latex のクラス) linking automatic literalinclude directive load_env() (sphinx.builders.Builder のメソッド) locale_dirs configuration value logo (組み込み変数)

M

mailheader role makevar role manpage role master_doc configuration value master_doc (組み込み変数) math directive role members (sphinx.ext.autosummary モジュール) menuselection role meta (組み込み変数) meth role

method directive methods (sphinx.ext.autosummary モジュール), [1] mimetype role missing-reference event mod role modindex_common_prefix configuration value module directive module (sphinx.ext.autosummary モジュール) moduleauthor directive

N

name (sphinx.ext.autosummary モジュール) newest_template_mtime() (sphinx.application.TemplateBridge のメソッド) newsgroup role

next (組み込み変数) note directive

O

obj role objname (sphinx.ext.autosummary モジュール) only directive

option role out_suffix (sphinx.builders.html.SerializingHTMLBuilder の属性)

P

page-context event pagename (組み込み変数) parents (組み込み変数) pathto() (組み込み関数), [1] pep role PickleHTMLBuilder (sphinx.builders.html のクラス) pngmath_dvipng configuration value pngmath_dvipng_args configuration value pngmath_latex configuration value pngmath_latex_args configuration value pngmath_latex_preamble configuration value

pngmath_use_preview configuration value prepare_writing() (sphinx.builders.Builder のメソッド) prev (組み込み変数) productionlist directive program directive role project configuration value project (組み込み変数) PyClass_Type (C の変数) pygments_style configuration value

Q

QtHelpBuilder (sphinx.builders.qthelp のクラス)

R

ref role regexp role relbar() (組み込み関数) reldelim1 (組み込み変数) reldelim2 (組み込み変数) release configuration value release (組み込み変数) rellinks (組み込み変数) render() (sphinx.application.TemplateBridge のメソッド) render_string() (sphinx.application.TemplateBridge のメソッド) rfc role role abbr attr cdata cfunc class cmacro command const ctype data dfn doc download envvar eq exc file func guilabel kbd keyword mailheader makevar manpage math menuselection meth mimetype mod newsgroup obj option pep program ref regexp rfc samp term token

rst_epilog configuration value rubric directive

S

samp role script_files (組み込み変数) searchindex_filename (sphinx.builders.html.SerializingHTMLBuilder の属性) sectionauthor directive seealso directive SerializingHTMLBuilder (sphinx.builders.html のクラス) setup_extension() (sphinx.application.Sphinx のメソッド) shorttitle (組み込み変数) show_authors configuration value show_source (組み込み変数) sidebar() (組み込み関数) source-read event source_encoding configuration value source_suffix configuration value sourcecode sourcename (組み込み変数) sphinx.application (モジュール) sphinx.builders (モジュール) sphinx.builders.changes (モジュール)

sphinx.builders.devhelp (モジュール) sphinx.builders.html (モジュール) sphinx.builders.htmlhelp (モジュール) sphinx.builders.latex (モジュール) sphinx.builders.linkcheck (モジュール) sphinx.builders.qthelp (モジュール) sphinx.builders.text (モジュール) sphinx.ext.autodoc (モジュール) sphinx.ext.autosummary (モジュール) sphinx.ext.coverage (モジュール) sphinx.ext.doctest (モジュール) sphinx.ext.graphviz (モジュール) sphinx.ext.ifconfig (モジュール) sphinx.ext.inheritance_diagram (モジュール) sphinx.ext.intersphinx (モジュール) sphinx.ext.jsmath (モジュール) sphinx.ext.mathbase (モジュール) sphinx.ext.pngmath (モジュール) sphinx.ext.refcounting (モジュール) sphinx.ext.todo (モジュール) sphinx_version (組み込み変数) StandaloneHTMLBuilder (sphinx.builders.html のクラス) staticmethod directive style (組み込み変数)

T

table of contents tabularcolumns directive template_bridge configuration value TemplateBridge (sphinx.application のクラス) templates_path configuration value term role testcode directive testoutput directive testsetup directive TextBuilder (sphinx.builders.text のクラス) title (組み込み変数) toc (組み込み変数)

toctree directive toctree (組み込み変数) today configuration value today_fmt configuration value todo directive todo_include_todos configuration value todolist directive token role trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

underline (sphinx.ext.autosummary モジュール) unused_docs configuration value

use_opensearch (組み込み変数)

V

version configuration value version (組み込み変数) versionadded directive

versionchanged directive

W

warning directive

write_doc() (sphinx.builders.Builder のメソッド)

Symbols

グローバル 置換 コンフィグレーションディレクトリ ソースディレクトリ テスト 簡易 自動 デフォルト ロール ドキュメンテーション 自動

ビルダー 環境 簡易 テスト 置換 グローバル 自動 テスト ドキュメンテーション 説明ユニット