Index

Symboles

--author option de ligne de commande sphinx-quickstart --batchfile option de ligne de commande sphinx-quickstart --builder option de ligne de commande sphinx-build --color option de ligne de commande sphinx-build --conf-dir option de ligne de commande sphinx-build --define option de ligne de commande sphinx-build --doctree-dir option de ligne de commande sphinx-build --dot option de ligne de commande sphinx-quickstart --dry-run option de ligne de commande sphinx-apidoc --exception-on-warning option de ligne de commande sphinx-build --ext-autodoc option de ligne de commande sphinx-quickstart --ext-coverage option de ligne de commande sphinx-quickstart --ext-doctest option de ligne de commande sphinx-quickstart --ext-githubpages option de ligne de commande sphinx-quickstart --ext-ifconfig option de ligne de commande sphinx-quickstart --ext-imgmath option de ligne de commande sphinx-quickstart --ext-intersphinx option de ligne de commande sphinx-quickstart --ext-mathjax option de ligne de commande sphinx-quickstart --ext-todo option de ligne de commande sphinx-quickstart --ext-viewcode option de ligne de commande sphinx-quickstart --extensions option de ligne de commande sphinx-quickstart --fail-on-warning option de ligne de commande sphinx-build --follow-links option de ligne de commande sphinx-apidoc --force option de ligne de commande sphinx-apidoc --fresh-env option de ligne de commande sphinx-build --full option de ligne de commande sphinx-apidoc --help option de ligne de commande sphinx-build option de ligne de commande sphinx-quickstart --html-define option de ligne de commande sphinx-build --implicit-namespaces option de ligne de commande sphinx-apidoc --imported-members option de ligne de commande sphinx-autogen --isolated option de ligne de commande sphinx-build --jobs option de ligne de commande sphinx-build --keep-going option de ligne de commande sphinx-build --language option de ligne de commande sphinx-quickstart --makefile option de ligne de commande sphinx-quickstart --master option de ligne de commande sphinx-quickstart --module-first option de ligne de commande sphinx-apidoc --nitpicky option de ligne de commande sphinx-build --no-batchfile option de ligne de commande sphinx-quickstart --no-color option de ligne de commande sphinx-build --no-headings option de ligne de commande sphinx-apidoc --no-makefile option de ligne de commande sphinx-quickstart --no-sep option de ligne de commande sphinx-quickstart --no-toc option de ligne de commande sphinx-apidoc --no-use-make-mode option de ligne de commande sphinx-quickstart --pdb option de ligne de commande sphinx-build --private option de ligne de commande sphinx-apidoc --project option de ligne de commande sphinx-quickstart --quiet option de ligne de commande sphinx-build option de ligne de commande sphinx-quickstart --release option de ligne de commande sphinx-quickstart --remove-old option de ligne de commande sphinx-apidoc option de ligne de commande sphinx-autogen --respect-module-all option de ligne de commande sphinx-autogen --sep option de ligne de commande sphinx-quickstart --separate option de ligne de commande sphinx-apidoc --show-traceback option de ligne de commande sphinx-build

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

_

_() (dans le module sphinx.locale) __() (dans le module sphinx.locale)

_object_hierarchy_parts() (méthode sphinx.directives.ObjectDescription) _parser (attribut sphinx.environment.BuildEnvironment.current_document) _toc_entry_name() (méthode sphinx.directives.ObjectDescription)

A

:abstract: (option de directive) py:class (directive) py:method (directive) py:property (directive) :abstractmethod: (option de directive) py:method (directive) py:property (directive) :align: (option de directive) digraph (directive) graph (directive) graphviz (directive) :alt: (option de directive) digraph (directive) graph (directive) graphviz (directive) :annotation: (option de directive) autodata (directive) :append: (option de directive) literalinclude (directive) :async: (option de directive) py:function (directive) py:method (directive) abbr (role) accept_comment() (méthode sphinxcontrib.websupport.storage.StorageBackend) add() (méthode sphinx.events.EventManager) add_autodoc_attrgetter() (méthode sphinx.application.Sphinx) add_autodocumenter() (méthode sphinx.application.Sphinx) add_builder() (méthode sphinx.application.Sphinx) add_comment() (méthode sphinxcontrib.websupport.storage.StorageBackend) (méthode sphinxcontrib.websupport.WebSupport) add_config_value() (méthode sphinx.application.Sphinx) add_crossref_type() (méthode sphinx.application.Sphinx) add_css_file() (méthode sphinx.application.Sphinx) add_directive() (méthode sphinx.application.Sphinx) add_directive_to_domain() (méthode sphinx.application.Sphinx) add_document() (méthode sphinxcontrib.websupport.search.BaseSearch) add_domain() (méthode sphinx.application.Sphinx) add_enumerable_node() (méthode sphinx.application.Sphinx) add_env_collector() (méthode sphinx.application.Sphinx) add_event() (méthode sphinx.application.Sphinx) add_function_parentheses valeur de configuration add_generic_role() (méthode sphinx.application.Sphinx) add_html_math_renderer() (méthode sphinx.application.Sphinx) add_html_theme() (méthode sphinx.application.Sphinx) add_index_to_domain() (méthode sphinx.application.Sphinx) add_js_file() (méthode sphinx.application.Sphinx) add_latex_package() (méthode sphinx.application.Sphinx) add_lexer() (méthode sphinx.application.Sphinx) add_linkcode_domain() (dans le module sphinx.ext.linkcode) add_message_catalog() (méthode sphinx.application.Sphinx) add_module_names valeur de configuration add_node() (méthode sphinx.application.Sphinx) (méthode sphinxcontrib.websupport.storage.StorageBackend) add_object_type() (méthode sphinx.application.Sphinx) (méthode sphinx.domains.Domain) add_post_transform() (méthode sphinx.application.Sphinx) add_role() (méthode sphinx.application.Sphinx) add_role_to_domain() (méthode sphinx.application.Sphinx) add_search_language() (méthode sphinx.application.Sphinx) add_source_parser() (méthode sphinx.application.Sphinx) add_source_suffix() (méthode sphinx.application.Sphinx) add_static_dir() (méthode sphinx.application.Sphinx) add_target_and_index() (méthode sphinx.directives.ObjectDescription) add_transform() (méthode sphinx.application.Sphinx) added in version admonition attention caution danger error hint important note tip warning admonition (directive) admonitions after_content() (méthode sphinx.directives.ObjectDescription) allow_parallel (attribut sphinx.builders.Builder) anchor (attribut sphinx.domains.IndexEntry) any (role) apidoc_automodule_options valeur de configuration apidoc_exclude_patterns valeur de configuration apidoc_follow_links valeur de configuration apidoc_implicit_namespaces valeur de configuration apidoc_include_private valeur de configuration apidoc_max_depth valeur de configuration apidoc_module_first valeur de configuration apidoc_modules valeur de configuration apidoc_no_headings valeur de configuration apidoc_separate_modules valeur de configuration app (attribut sphinx.environment.BuildEnvironment) (propriété sphinx.transforms.SphinxTransform) applehelp_bundle_id valeur de configuration applehelp_bundle_name valeur de configuration applehelp_bundle_version valeur de configuration applehelp_codesign_flags valeur de configuration applehelp_codesign_identity valeur de configuration applehelp_codesign_path valeur de configuration applehelp_dev_region valeur de configuration applehelp_disable_external_tools valeur de configuration applehelp_icon valeur de configuration applehelp_index_anchors valeur de configuration applehelp_indexer_path valeur de configuration applehelp_kb_product valeur de configuration applehelp_kb_url valeur de configuration applehelp_locale valeur de configuration

applehelp_min_term_length valeur de configuration applehelp_remote_url valeur de configuration applehelp_stopwords valeur de configuration applehelp_title valeur de configuration AppleHelpBuilder (classe dans sphinxcontrib.applehelp) apply() (méthode sphinx.transforms.post_transforms.SphinxPostTransform) arguments (attribut docutils.parsers.rst.Directive) attention admonition attention (directive) attributes (variable de base) author valeur de configuration autoattribute (directive) autoclass (directive) :class-doc-from: (option de directive) :exclude-members: (option de directive) :inherited-members: (option de directive) :member-order: (option de directive) :members: (option de directive) :no-index-entry: (option de directive) :no-index: (option de directive) :private-members: (option de directive) :show-inheritance: (option de directive) :special-members: (option de directive) :undoc-members: (option de directive) autoclass_content valeur de configuration autodata (directive) :annotation: (option de directive) :no-index-entry: (option de directive) :no-index: (option de directive) :no-value: (option de directive) autodecorator (directive) autodoc-before-process-signature event autodoc-process-bases event autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event autodoc_class_signature valeur de configuration autodoc_default_options valeur de configuration autodoc_docstring_signature valeur de configuration autodoc_inherit_docstrings valeur de configuration autodoc_member_order valeur de configuration autodoc_mock_imports valeur de configuration autodoc_preserve_defaults valeur de configuration autodoc_type_aliases valeur de configuration autodoc_typehints valeur de configuration autodoc_typehints_description_target valeur de configuration autodoc_typehints_format valeur de configuration autodoc_use_legacy_class_based valeur de configuration autodoc_use_type_comments valeur de configuration autodoc_warningiserror valeur de configuration autoexception (directive) autofunction (directive) :no-index-entry: (option de directive) :no-index: (option de directive) autolink (role) automatic documentation, [1] linking testing automethod (directive) automodule (directive) :deprecated: (option de directive) :exclude-members: (option de directive) :ignore-module-all: (option de directive) :imported-members: (option de directive) :member-order: (option de directive) :members: (option de directive) :no-index-entry: (option de directive) :no-index: (option de directive) :platform: (option de directive) :private-members: (option de directive) :show-inheritance: (option de directive) :special-members: (option de directive) :synopsis: (option de directive) :undoc-members: (option de directive) autoproperty (directive) autosectionlabel_maxdepth valeur de configuration autosectionlabel_prefix_document valeur de configuration autosummary (directive) :caption: (option de directive) :class: (option de directive) :nosignatures: (option de directive) :recursive: (option de directive) :signatures: (option de directive) :template: (option de directive) :toctree: (option de directive) autosummary_context valeur de configuration autosummary_filename_map valeur de configuration autosummary_generate valeur de configuration autosummary_generate_overwrite valeur de configuration autosummary_ignore_module_all valeur de configuration autosummary_imported_members valeur de configuration autosummary_mock_imports valeur de configuration autotype (directive) :no-index-entry: (option de directive) :no-index: (option de directive) available (attribut sphinx.transforms.post_transforms.images.ImageConverter)

B

BaseSearch (classe dans sphinxcontrib.websupport.search) before_content() (méthode sphinx.directives.ObjectDescription) between() (dans le module sphinx.ext.autodoc) block_text (attribut docutils.parsers.rst.Directive) body (variable de base) build() (méthode sphinx.builders.Builder) (méthode sphinxcontrib.websupport.WebSupport) build-finished event build_all() (méthode sphinx.builders.Builder) build_specific() (méthode sphinx.builders.Builder) build_update() (méthode sphinx.builders.Builder)

BuildEnvironment (classe dans sphinx.environment) Builder (classe dans sphinx.builders) builder (variable de base) builder-inited event built-in function enumerate() escape() hasdoc() pathto() relbar() sidebar() warning()

C

:canonical: (option de directive) py:attribute (directive) py:class (directive) py:data (directive) py:function (directive) py:method (directive) py:type (directive) :caption: (option de directive) autosummary (directive) code-block (directive) digraph (directive) graph (directive) graphviz (directive) literalinclude (directive) toctree (directive) :class-doc-from: (option de directive) autoclass (directive) :class: (option de directive) autosummary (directive) code-block (directive) digraph (directive) graph (directive) graphviz (directive) literalinclude (directive) math (directive) rubric (directive) toctree (directive) :classmethod: (option de directive) py:method (directive) py:property (directive) :columns: (option de directive) hlist (directive) c:alias (directive) :maxdepth: (option de directive) :noroot: (option de directive) c:data (role) c:enum (directive) (role) c:enumerator (directive) (role) c:expr (role) c:func (role) c:function (directive) :single-line-parameter-list: (option de directive) c:macro (directive) :single-line-parameter-list: (option de directive) c:macro (role) c:member (directive) (role) c:namespace (directive) c:namespace-pop (directive) c:namespace-push (directive) c:struct (directive) (role) c:texpr (role) c:type (directive) (role) c:union (directive) (role) c:var (directive) (role) c_extra_keywords valeur de configuration c_id_attributes valeur de configuration c_maximum_signature_line_length valeur de configuration c_paren_attributes valeur de configuration category (attribut sphinx.errors.SphinxError) caution admonition caution (directive) centered (directive) changes in version ChangesBuilder (classe dans sphinx.builders.changes) check_consistency() (méthode sphinx.domains.Domain) CheckExternalLinksBuilder (classe dans sphinx.builders.linkcheck) class (variable de base) classes (variable de base) clear_doc() (méthode sphinx.domains.Domain) (méthode sphinx.environment.collectors.EnvironmentCollector) code examples code (directive) (role) code-block (directive) :caption: (option de directive) :class: (option de directive) :dedent: (option de directive) :emphasize-lines: (option de directive) :force: (option de directive) :lineno-start: (option de directive) :linenos: (option de directive) :name: (option de directive) codeauthor (directive) command (role) compact_paragraph (classe dans sphinx.addnodes) conf module

confdir (attribut sphinx.application.Sphinx) config (attribut sphinx.environment.BuildEnvironment) Config (classe dans sphinx.config) config (propriété sphinx.parsers.Parser) (propriété sphinx.transforms.SphinxTransform) (propriété sphinx.util.docutils.SphinxDirective) (propriété sphinx.util.docutils.SphinxRole) config-inited event ConfigError confval (directive) :default: (option de directive) :type: (option de directive) confval (role) connect() (méthode sphinx.application.Sphinx) (méthode sphinx.events.EventManager) constructeur content (attribut docutils.parsers.rst.Directive) (attribut sphinx.util.docutils.SphinxRole) content_offset (attribut docutils.parsers.rst.Directive) contents table of conversion_rules (attribut sphinx.transforms.post_transforms.images.ImageConverter) convert() (méthode sphinx.transforms.post_transforms.images.ImageConverter) copy_assets() (méthode sphinx.builders.Builder) copyright valeur de configuration copyright (variable de base) coverage_c_path valeur de configuration coverage_c_regexes valeur de configuration coverage_ignore_c_items valeur de configuration coverage_ignore_classes valeur de configuration coverage_ignore_functions valeur de configuration coverage_ignore_modules valeur de configuration coverage_ignore_pyobjects valeur de configuration coverage_modules valeur de configuration coverage_show_missing_items valeur de configuration coverage_skip_undoc_in_source valeur de configuration coverage_statistics_to_report valeur de configuration coverage_statistics_to_stdout valeur de configuration coverage_write_headline valeur de configuration CoverageBuilder (classe dans sphinx.ext.coverage) cpp:alias (directive) :maxdepth: (option de directive) :noroot: (option de directive) cpp:any (role) cpp:class (directive) (role) cpp:concept (directive) (role) cpp:enum (directive) (role) cpp:enum-class (directive) cpp:enum-struct (directive) cpp:enumerator (directive) (role) cpp:expr (role) cpp:func (role) cpp:function (directive) :single-line-parameter-list: (option de directive) cpp:member (directive) (role) cpp:namespace (directive) cpp:namespace-pop (directive) cpp:namespace-push (directive) cpp:struct (directive) (role) cpp:texpr (role) cpp:type (directive) (role) cpp:union (directive) cpp:var (directive) (role) cpp_id_attributes valeur de configuration cpp_index_common_prefix valeur de configuration cpp_maximum_signature_line_length valeur de configuration cpp_paren_attributes valeur de configuration critical() (méthode sphinx.util.logging.SphinxLoggerAdapter) current_document (attribut sphinx.environment.BuildEnvironment) CustomList (C++ type) cut_lines() (dans le module sphinx.ext.autodoc) cve (role) cwe (role)

D

:dedent: (option de directive) code-block (directive) literalinclude (directive) :default: (option de directive) confval (directive) :deprecated: (option de directive) automodule (directive) py:module (directive) :diff: (option de directive) literalinclude (directive) danger admonition danger (directive) dangling_warnings (attribut sphinx.domains.Domain) data (attribut sphinx.domains.Domain) data_version (attribut sphinx.domains.Domain) debug() (méthode sphinx.util.logging.SphinxLoggerAdapter) default domain role default-domain (directive) default_domain (attribut sphinx.environment.BuildEnvironment.current_document) default_priority (attribut sphinx.transforms.post_transforms.images.ImageConverter) default_role valeur de configuration default_role (attribut sphinx.environment.BuildEnvironment.current_document) default_translator_class (attribut sphinx.builders.Builder) delete_comment() (méthode sphinxcontrib.websupport.storage.StorageBackend) deprecated (directive) desc (classe dans sphinx.addnodes) desc_addname (classe dans sphinx.addnodes) desc_annotation (classe dans sphinx.addnodes) desc_content (classe dans sphinx.addnodes) desc_inline (classe dans sphinx.addnodes) desc_name (classe dans sphinx.addnodes) desc_optional (classe dans sphinx.addnodes) desc_parameter (classe dans sphinx.addnodes) desc_parameterlist (classe dans sphinx.addnodes) desc_returns (classe dans sphinx.addnodes) desc_sig_element (classe dans sphinx.addnodes) desc_sig_keyword (classe dans sphinx.addnodes) desc_sig_keyword_type (classe dans sphinx.addnodes) desc_sig_literal_char (classe dans sphinx.addnodes) desc_sig_literal_number (classe dans sphinx.addnodes) desc_sig_literal_string (classe dans sphinx.addnodes) desc_sig_name (classe dans sphinx.addnodes) desc_sig_operator (classe dans sphinx.addnodes) desc_sig_punctuation (classe dans sphinx.addnodes) desc_sig_space (classe dans sphinx.addnodes) desc_signature (classe dans sphinx.addnodes) desc_signature_line (classe dans sphinx.addnodes) desc_type (classe dans sphinx.addnodes) descr (attribut sphinx.domains.IndexEntry) describe (directive) DevhelpBuilder (classe dans sphinxcontrib.devhelp) dfn (role) digraph (directive) :align: (option de directive) :alt: (option de directive) :caption: (option de directive) :class: (option de directive) :layout: (option de directive) :name: (option de directive) directive Directive (classe dans docutils.parsers.rst) directive() (méthode sphinx.domains.Domain) directives (attribut sphinx.domains.Domain)

DirectoryHTMLBuilder (classe dans sphinx.builders.dirhtml) disabled (attribut sphinx.util.docutils.ReferenceRole) disconnect() (méthode sphinx.application.Sphinx) (méthode sphinx.events.EventManager) discover() (méthode sphinx.project.Project) display_toc (variable de base) doc (role) doc2path() (méthode sphinx.environment.BuildEnvironment) (méthode sphinx.project.Project) docname (attribut sphinx.domains.IndexEntry) (attribut sphinx.environment.BuildEnvironment) (attribut sphinx.environment.BuildEnvironment.current_document) docnames (attribut sphinx.project.Project) docstitle (variable de base) docstring doctest doctest (directive) :hide: (option de directive) :no-trim-doctest-flags: (option de directive) :options: (option de directive) :pyversion: (option de directive) :skipif: (option de directive) :trim-doctest-flags: (option de directive) doctest_default_flags valeur de configuration doctest_fail_fast valeur de configuration doctest_global_cleanup valeur de configuration doctest_global_setup valeur de configuration doctest_path valeur de configuration doctest_show_successes valeur de configuration doctest_test_doctest_blocks valeur de configuration doctree-read event doctree-resolved event doctreedir (attribut sphinx.application.Sphinx) (attribut sphinx.environment.BuildEnvironment) document racine documentation automatic, [1] generate generation docutils.parsers.rst module docutils_version_info (variable de base) domain default Domain (classe dans sphinx.domains) domaine download (role) download_reference (classe dans sphinx.addnodes) DummyBuilder (classe dans sphinx.builders.dummy) duration_limit valeur de configuration duration_n_slowest valeur de configuration duration_print_slowest valeur de configuration duration_print_total valeur de configuration duration_write_json valeur de configuration

E

:emphasize-lines: (option de directive) code-block (directive) literalinclude (directive) :encoding: (option de directive) literalinclude (directive) :end-at: (option de directive) literalinclude (directive) :end-before: (option de directive) literalinclude (directive) :exclude-members: (option de directive) autoclass (directive) automodule (directive) embedded (variable de base) emit() (méthode sphinx.application.Sphinx) (méthode sphinx.events.EventManager) emit_firstresult() (méthode sphinx.application.Sphinx) (méthode sphinx.events.EventManager) ENUM (classe dans sphinx.config) enumerable_nodes (attribut sphinx.domains.Domain) enumerate() built-in function env (propriété sphinx.parsers.Parser) (propriété sphinx.transforms.SphinxTransform) (propriété sphinx.util.docutils.SphinxDirective) (propriété 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 (attribut sphinx.util.typing.ExtensionMetadata) environment EnvironmentCollector (classe dans sphinx.environment.collectors) envvar (directive) (role) epilog (attribut sphinx.builders.Builder) Epub3Builder (classe dans sphinx.builders.epub3) epub_author valeur de configuration epub_basename valeur de configuration epub_contributor valeur de configuration epub_copyright valeur de configuration epub_cover valeur de configuration epub_css_files valeur de configuration epub_description valeur de configuration epub_exclude_files valeur de configuration epub_fix_images valeur de configuration epub_guide valeur de configuration epub_identifier valeur de configuration epub_language valeur de configuration epub_max_image_width valeur de configuration epub_post_files valeur de configuration epub_pre_files valeur de configuration epub_publisher valeur de configuration epub_scheme valeur de configuration

epub_show_urls valeur de configuration epub_theme valeur de configuration epub_theme_options valeur de configuration epub_title valeur de configuration epub_tocdepth valeur de configuration epub_tocdup valeur de configuration epub_tocscope valeur de configuration epub_uid valeur de configuration epub_use_index valeur de configuration epub_writing_mode valeur de configuration eq (role) error admonition error (directive) error() (méthode 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 (classe dans sphinx.events) events (attribut sphinx.builders.Builder) (attribut sphinx.environment.BuildEnvironment) examples code exceptions (variable de base) exclude_patterns valeur de configuration extension ExtensionError, [1] ExtensionMetadata (classe dans sphinx.util.typing) extensions valeur de configuration external (role) extlinks valeur de configuration extlinks_detect_hardcoded_links valeur de configuration extra (attribut sphinx.domains.IndexEntry) extract_context() (méthode sphinxcontrib.websupport.search.BaseSearch) Énumération des faiblesses communes CWE 787

F

:final: (option de directive) py:class (directive) py:exception (directive) py:method (directive) :force: (option de directive) code-block (directive) highlight (directive) literalinclude (directive) favicon_url (variable de base) feed() (méthode sphinxcontrib.websupport.search.BaseSearch) figure_language_filename valeur de configuration file (role) file_suffix (variable de base) final_argument_whitespace (attribut docutils.parsers.rst.Directive) (attribut sphinx.directives.ObjectDescription) finish() (méthode sphinx.builders.Builder) finish_indexing() (méthode sphinxcontrib.websupport.search.BaseSearch) format (attribut sphinx.builders.Builder) (attribut sphinx.builders.changes.ChangesBuilder) (attribut sphinx.builders.dirhtml.DirectoryHTMLBuilder) (attribut sphinx.builders.epub3.Epub3Builder) (attribut sphinx.builders.gettext.MessageCatalogBuilder) (attribut sphinx.builders.html.StandaloneHTMLBuilder) (attribut sphinx.builders.latex.LaTeXBuilder) (attribut sphinx.builders.linkcheck.CheckExternalLinksBuilder) (attribut sphinx.builders.manpage.ManualPageBuilder) (attribut sphinx.builders.singlehtml.SingleFileHTMLBuilder) (attribut sphinx.builders.texinfo.TexinfoBuilder) (attribut sphinx.builders.text.TextBuilder) (attribut sphinx.builders.xml.PseudoXMLBuilder) (attribut sphinx.builders.xml.XMLBuilder) (attribut sphinxcontrib.applehelp.AppleHelpBuilder) (attribut sphinxcontrib.devhelp.DevhelpBuilder) (attribut sphinxcontrib.htmlhelp.HTMLHelpBuilder) (attribut sphinxcontrib.qthelp.QtHelpBuilder) (attribut sphinxcontrib.serializinghtml.JSONHTMLBuilder) (attribut sphinxcontrib.serializinghtml.PickleHTMLBuilder)

found_docs (attribut sphinx.environment.BuildEnvironment) fresh_env_used (attribut sphinx.application.Sphinx) fullname (variable de base) functions (variable de base)

G

:glob: (option de directive) toctree (directive) generate documentation generate() (méthode sphinx.domains.Index) generation documentation genindex toctree get_data() (méthode sphinxcontrib.websupport.storage.StorageBackend) (méthode sphinxcontrib.websupport.WebSupport) get_document() (méthode sphinxcontrib.websupport.WebSupport) get_enumerable_node_type() (méthode sphinx.domains.Domain) get_full_qualified_name() (méthode sphinx.domains.Domain) get_location() (méthode sphinx.util.docutils.SphinxDirective) (méthode sphinx.util.docutils.SphinxRole) get_objects() (méthode sphinx.domains.Domain) get_outdated_docs() (méthode sphinx.builders.Builder) (méthode sphinx.environment.collectors.EnvironmentCollector) get_relative_uri() (méthode sphinx.builders.Builder) get_search_results() (méthode sphinxcontrib.websupport.WebSupport) get_signatures() (méthode sphinx.directives.ObjectDescription) get_source_info() (méthode sphinx.util.docutils.SphinxDirective) get_target_uri() (méthode sphinx.builders.Builder) get_translation() (dans le module sphinx.locale) get_type_name() (méthode sphinx.domains.Domain) get_updated_docs() (méthode sphinx.environment.collectors.EnvironmentCollector) getLogger() (dans le module sphinx.util.logging) gettext_additional_targets valeur de configuration gettext_allow_fuzzy_translations valeur de configuration gettext_auto_build valeur de configuration

gettext_compact valeur de configuration gettext_location valeur de configuration gettext_uuid valeur de configuration global substitutions, [1], [2] globalcontext_filename (attribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) glossary (classe dans sphinx.addnodes) glossary (directive) :sorted: (option de directive) graph (directive) :align: (option de directive) :alt: (option de directive) :caption: (option de directive) :class: (option de directive) :layout: (option de directive) :name: (option de directive) graphviz (directive) :align: (option de directive) :alt: (option de directive) :caption: (option de directive) :class: (option de directive) :layout: (option de directive) :name: (option de directive) graphviz_dot valeur de configuration graphviz_dot_args valeur de configuration graphviz_output_format valeur de configuration guilabel (role)

H

:heading-level: (option de directive) rubric (directive) :hidden: (option de directive) toctree (directive) :hide: (option de directive) doctest (directive) testcode (directive) testoutput (directive) handle_query() (méthode sphinxcontrib.websupport.search.BaseSearch) handle_signature() (méthode sphinx.directives.ObjectDescription) has_content (attribut docutils.parsers.rst.Directive) (attribut sphinx.directives.ObjectDescription) has_explicit_title (attribut sphinx.util.docutils.ReferenceRole) has_source (variable de base) hasdoc() built-in function highlight (directive) :force: (option de directive) :linenothreshold: (option de directive) highlight_language valeur de configuration highlight_language (attribut sphinx.environment.BuildEnvironment.current_document) highlight_options valeur de configuration highlightlang (classe dans sphinx.addnodes) hint admonition hint (directive) hlist (directive) :columns: (option de directive) html-collect-pages event html-page-context event html_additional_pages valeur de configuration html_baseurl valeur de configuration html_codeblock_linenos_style valeur de configuration html_compact_lists valeur de configuration html_context valeur de configuration html_copy_source valeur de configuration html_css_files valeur de configuration html_domain_indices valeur de configuration html_extra_path valeur de configuration html_favicon valeur de configuration html_file_suffix valeur de configuration html_js_files valeur de configuration html_last_updated_fmt valeur de configuration html_last_updated_use_utc valeur de configuration

html_link_suffix valeur de configuration html_logo valeur de configuration html_math_renderer valeur de configuration html_output_encoding valeur de configuration html_permalinks valeur de configuration html_permalinks_icon valeur de configuration html_scaled_image_link valeur de configuration html_search_language valeur de configuration html_search_options valeur de configuration html_search_scorer valeur de configuration html_secnumber_suffix valeur de configuration html_short_title valeur de configuration html_show_copyright valeur de configuration html_show_search_summary valeur de configuration html_show_sourcelink valeur de configuration html_show_sphinx valeur de configuration html_sidebars valeur de configuration html_sourcelink_suffix valeur de configuration html_split_index valeur de configuration html_static_path valeur de configuration html_style valeur de configuration html_theme valeur de configuration html_theme_options valeur de configuration html_theme_path valeur de configuration html_title valeur de configuration html_use_index valeur de configuration html_use_opensearch valeur de configuration htmlhelp_basename valeur de configuration htmlhelp_file_suffix valeur de configuration htmlhelp_link_suffix valeur de configuration HTMLHelpBuilder (classe dans sphinxcontrib.htmlhelp)

I

:ignore-module-all: (option de directive) automodule (directive) :imported-members: (option de directive) automodule (directive) :include-subclasses: (option de directive) inheritance-diagram (directive) :includehidden: (option de directive) toctree (directive) :inherited-members: (option de directive) autoclass (directive) ifconfig (directive) image_converter valeur de configuration image_converter_args valeur de configuration ImageConverter (classe dans sphinx.transforms.post_transforms.images) imgmath_add_tooltips valeur de configuration imgmath_dvipng valeur de configuration imgmath_dvipng_args valeur de configuration imgmath_dvisvgm valeur de configuration imgmath_dvisvgm_args valeur de configuration imgmath_embed valeur de configuration imgmath_font_size valeur de configuration imgmath_image_format valeur de configuration imgmath_latex valeur de configuration imgmath_latex_args valeur de configuration imgmath_latex_preamble valeur de configuration imgmath_use_preview valeur de configuration implementation (attribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) important admonition important (directive) in version added changes removed

include-read event include_patterns valeur de configuration index (classe dans sphinx.addnodes) Index (classe dans sphinx.domains) index (directive) :name: (option de directive) index (role) IndexEntry (classe dans sphinx.domains) indices (attribut sphinx.domains.Domain) info() (méthode sphinx.util.logging.SphinxLoggerAdapter) inheritance-diagram (directive) :include-subclasses: (option de directive) inheritance_alias valeur de configuration inheritance_edge_attrs valeur de configuration inheritance_graph_attrs valeur de configuration inheritance_node_attrs valeur de configuration inherited_members (variable de base) init() (dans le module sphinx.locale) (méthode sphinx.application.TemplateBridge) (méthode sphinx.builders.Builder) init_console() (dans le module sphinx.locale) init_indexing() (méthode sphinxcontrib.websupport.search.BaseSearch) initial_data (attribut sphinx.domains.Domain) inliner (attribut sphinx.util.docutils.SphinxRole) intersphinx_cache_limit valeur de configuration intersphinx_disabled_reftypes valeur de configuration intersphinx_mapping valeur de configuration intersphinx_resolve_self valeur de configuration intersphinx_timeout valeur de configuration is_available() (méthode sphinx.transforms.post_transforms.images.ImageConverter) is_parallel_allowed() (méthode sphinx.application.Sphinx) is_supported() (méthode sphinx.transforms.post_transforms.SphinxPostTransform)

J

javascript_maximum_signature_line_length valeur de configuration javascript_trailing_comma_in_multi_line_signatures valeur de configuration js:attr (role) js:attribute (directive) js:class (directive) :single-line-parameter-list: (option de directive) js:class (role) js:data (directive) (role)

js:func (role) js:function (directive) :single-line-parameter-list: (option de directive) js:meth (role) js:method (directive) :single-line-parameter-list: (option de directive) js:mod (role) js:module (directive) jsmath_path valeur de configuration JSONHTMLBuilder (classe dans sphinxcontrib.serializinghtml)

K

kbd (role) keep_warnings valeur de configuration

keyword (role)

L

:label: (option de directive) math (directive) :language: (option de directive) literalinclude (directive) :layout: (option de directive) digraph (directive) graph (directive) graphviz (directive) :lineno-match: (option de directive) literalinclude (directive) :lineno-start: (option de directive) code-block (directive) literalinclude (directive) :linenos: (option de directive) code-block (directive) literalinclude (directive) :linenothreshold: (option de directive) highlight (directive) :lines: (option de directive) literalinclude (directive) label (attribut sphinx.domains.Domain) language valeur de configuration language (variable de base) last_updated (variable de base) latex module latex_additional_files valeur de configuration latex_appendices valeur de configuration latex_docclass valeur de configuration latex_documents valeur de configuration latex_domain_indices valeur de configuration latex_elements valeur de configuration latex_engine valeur de configuration latex_logo valeur de configuration latex_show_pagerefs valeur de configuration latex_show_urls valeur de configuration latex_table_style valeur de configuration latex_theme valeur de configuration latex_theme_options valeur de configuration latex_theme_path valeur de configuration latex_toplevel_sectioning valeur de configuration latex_use_latex_multicolumn valeur de configuration latex_use_xindy valeur de configuration LaTeXBuilder (classe dans sphinx.builders.latex) lineno (attribut docutils.parsers.rst.Directive) (attribut sphinx.util.docutils.SphinxRole)

linkcheck-process-uri event linkcheck_allow_unauthorized valeur de configuration linkcheck_allowed_redirects valeur de configuration linkcheck_anchors valeur de configuration linkcheck_anchors_ignore valeur de configuration linkcheck_anchors_ignore_for_url valeur de configuration linkcheck_auth valeur de configuration linkcheck_case_insensitive_urls valeur de configuration linkcheck_exclude_documents valeur de configuration linkcheck_ignore valeur de configuration linkcheck_rate_limit_timeout valeur de configuration linkcheck_report_timeouts_as_broken valeur de configuration linkcheck_request_headers valeur de configuration linkcheck_retries valeur de configuration linkcheck_timeout valeur de configuration linkcheck_workers valeur de configuration linkcode_resolve valeur de configuration linking automatic literal_emphasis (classe dans sphinx.addnodes) literalinclude (directive) :append: (option de directive) :caption: (option de directive) :class: (option de directive) :dedent: (option de directive) :diff: (option de directive) :emphasize-lines: (option de directive) :encoding: (option de directive) :end-at: (option de directive) :end-before: (option de directive) :force: (option de directive) :language: (option de directive) :lineno-match: (option de directive) :lineno-start: (option de directive) :linenos: (option de directive) :lines: (option de directive) :name: (option de directive) :prepend: (option de directive) :pyobject: (option de directive) :start-after: (option de directive) :start-at: (option de directive) :tab-width: (option de directive) locale_dirs valeur de configuration log() (méthode sphinx.util.logging.SphinxLoggerAdapter) logo_url (variable de base)

M

:maxdepth: (option de directive) c:alias (directive) cpp:alias (directive) :member-order: (option de directive) autoclass (directive) automodule (directive) :members: (option de directive) autoclass (directive) automodule (directive) mailheader (role) makevar (role) man_make_section_directory valeur de configuration man_pages valeur de configuration man_show_urls valeur de configuration manpage (role) manpages_url valeur de configuration ManualPageBuilder (classe dans sphinx.builders.manpage) master document master_doc valeur de configuration master_doc (variable de base) math (directive) :class: (option de directive) :label: (option de directive) :name: (option de directive) :no-wrap: (option de directive) math (role) math:numref (role) math_eqref_format valeur de configuration math_number_all valeur de configuration math_numfig valeur de configuration math_numsep valeur de configuration mathjax2_config valeur de configuration mathjax3_config valeur de configuration mathjax4_config valeur de configuration mathjax_config valeur de configuration mathjax_config_path valeur de configuration mathjax_options valeur de configuration mathjax_path valeur de configuration maximum_signature_line_length valeur de configuration members (variable de base) menuselection (role) merge_domaindata() (méthode sphinx.domains.Domain) merge_other() (méthode sphinx.environment.collectors.EnvironmentCollector) MessageCatalogBuilder (classe dans sphinx.builders.gettext) meta (variable de base) metadata (attribut sphinx.environment.BuildEnvironment) metatags (variable de base) methods (variable de base)

mimetype (role) missing-reference event modindex toctree modindex_common_prefix valeur de configuration 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 (variable de base) modules (attribut sphinx.domains.python.PythonDomain) (variable de base)

N

:name: (option de directive) code-block (directive) digraph (directive) graph (directive) graphviz (directive) index (directive) literalinclude (directive) math (directive) rubric (directive) toctree (directive) :no-index-entry: (option de directive) autoclass (directive) autodata (directive) autofunction (directive) automodule (directive) autotype (directive) :no-index: (option de directive) autoclass (directive) autodata (directive) autofunction (directive) automodule (directive) autotype (directive) :no-trim-doctest-flags: (option de directive) doctest (directive) testcode (directive) testoutput (directive) :no-value: (option de directive) autodata (directive) :no-wrap: (option de directive) math (directive) :noroot: (option de directive) c:alias (directive) cpp:alias (directive) :nosignatures: (option de directive) autosummary (directive) :numbered: (option de directive) toctree (directive) name (attribut docutils.parsers.rst.Directive) (attribut sphinx.builders.Builder) (attribut sphinx.builders.changes.ChangesBuilder) (attribut sphinx.builders.dirhtml.DirectoryHTMLBuilder) (attribut sphinx.builders.dummy.DummyBuilder) (attribut sphinx.builders.epub3.Epub3Builder) (attribut sphinx.builders.gettext.MessageCatalogBuilder) (attribut sphinx.builders.html.StandaloneHTMLBuilder) (attribut sphinx.builders.latex.LaTeXBuilder) (attribut sphinx.builders.linkcheck.CheckExternalLinksBuilder) (attribut sphinx.builders.manpage.ManualPageBuilder) (attribut sphinx.builders.singlehtml.SingleFileHTMLBuilder) (attribut sphinx.builders.texinfo.TexinfoBuilder) (attribut sphinx.builders.text.TextBuilder) (attribut sphinx.builders.xml.PseudoXMLBuilder) (attribut sphinx.builders.xml.XMLBuilder) (attribut sphinx.domains.Domain) (attribut sphinx.domains.IndexEntry) (attribut sphinx.util.docutils.SphinxRole) (attribut sphinxcontrib.applehelp.AppleHelpBuilder) (attribut sphinxcontrib.devhelp.DevhelpBuilder) (attribut sphinxcontrib.htmlhelp.HTMLHelpBuilder) (attribut sphinxcontrib.qthelp.QtHelpBuilder) (attribut sphinxcontrib.serializinghtml.JSONHTMLBuilder) (attribut sphinxcontrib.serializinghtml.PickleHTMLBuilder) (variable de base)

napoleon_attr_annotations valeur de configuration napoleon_custom_sections valeur de configuration napoleon_google_docstring valeur de configuration napoleon_include_init_with_doc valeur de configuration napoleon_include_private_with_doc valeur de configuration napoleon_include_special_with_doc valeur de configuration napoleon_numpy_docstring valeur de configuration napoleon_preprocess_types valeur de configuration napoleon_type_aliases valeur de configuration napoleon_use_admonition_for_examples valeur de configuration napoleon_use_admonition_for_notes valeur de configuration napoleon_use_admonition_for_references valeur de configuration napoleon_use_ivar valeur de configuration napoleon_use_keyword valeur de configuration napoleon_use_param valeur de configuration napoleon_use_rtype valeur de configuration needs_extensions valeur de configuration needs_sphinx valeur de configuration nested_parse_to_nodes() (dans le module sphinx.util.parsing) new_serialno() (méthode sphinx.environment.BuildEnvironment) newest_template_mtime() (méthode sphinx.application.TemplateBridge) newsgroup (role) next (variable de base) nitpick_ignore valeur de configuration nitpick_ignore_regex valeur de configuration nitpicky valeur de configuration nom du document note admonition note (directive) note_dependency() (méthode sphinx.environment.BuildEnvironment) note_module() (méthode sphinx.domains.python.PythonDomain) note_object() (méthode sphinx.domains.python.PythonDomain) note_reread() (méthode sphinx.environment.BuildEnvironment) numfig valeur de configuration numfig_format valeur de configuration numfig_secnum_depth valeur de configuration numref (role)

O

:options: (option de directive) doctest (directive) testoutput (directive) object (directive) object-description-transform event object_types (attribut sphinx.domains.Domain) ObjectDescription (classe dans sphinx.directives) objects (attribut sphinx.domains.python.PythonDomain) objet objname (variable de base) ObjType (classe dans sphinx.domains) objtype (variable de base) only (classe dans sphinx.addnodes) (directive) option (directive) (role) option de ligne de commande 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 option de ligne de commande sphinx-autogen --imported-members --remove-old --respect-module-all --suffix --templates -a -i -o -s -t option de ligne de commande 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

option de ligne de commande 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 option_emphasise_placeholders valeur de configuration option_spec (attribut docutils.parsers.rst.Directive) (attribut sphinx.directives.ObjectDescription) optional_arguments (attribut docutils.parsers.rst.Directive) (attribut sphinx.directives.ObjectDescription) options (attribut docutils.parsers.rst.Directive) (attribut sphinx.util.docutils.SphinxRole) out_suffix (attribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) outdir (attribut sphinx.application.Sphinx)

P

:platform: (option de directive) automodule (directive) py:module (directive) :prepend: (option de directive) literalinclude (directive) :private-members: (option de directive) autoclass (directive) automodule (directive) :pyobject: (option de directive) literalinclude (directive) :pyversion: (option de directive) doctest (directive) page_source_suffix (variable de base) pagename (variable de base) parallel_read_safe (attribut sphinx.util.typing.ExtensionMetadata) parallel_write_safe (attribut sphinx.util.typing.ExtensionMetadata) parents (variable de base) parse_content_to_nodes() (méthode sphinx.util.docutils.SphinxDirective) parse_inline() (méthode sphinx.util.docutils.SphinxDirective) parse_text_to_nodes() (méthode sphinx.util.docutils.SphinxDirective) parser (attribut sphinx.environment.BuildEnvironment) Parser (classe dans sphinx.parsers) path2doc() (méthode sphinx.project.Project) pathto() built-in function pending_logging() (dans le module sphinx.util.logging) pending_warnings() (dans le module sphinx.util.logging) pending_xref (classe dans sphinx.addnodes) pending_xref_condition (classe dans sphinx.addnodes) pep (role) PickleHTMLBuilder (classe dans sphinxcontrib.serializinghtml) post_build() (méthode sphinxcontrib.websupport.storage.StorageBackend) pre_build() (méthode sphinxcontrib.websupport.storage.StorageBackend) prefixed_warnings() (dans le module sphinx.util.logging) prepare_writing() (méthode sphinx.builders.Builder) prev (variable de base) primary_domain valeur de configuration process_doc() (méthode sphinx.domains.Domain) (méthode sphinx.environment.collectors.EnvironmentCollector) process_field_xref() (méthode sphinx.domains.Domain) process_vote() (méthode sphinxcontrib.websupport.storage.StorageBackend) (méthode sphinxcontrib.websupport.WebSupport) production (classe dans sphinx.addnodes) productionlist (classe dans sphinx.addnodes) (directive) program (directive) (role) project valeur de configuration project (attribut sphinx.application.Sphinx) (attribut sphinx.environment.BuildEnvironment) Project (classe dans sphinx.project) project (variable de base) project_copyright valeur de configuration PseudoXMLBuilder (classe dans sphinx.builders.xml) py:attr (role) py:attribute (directive) :canonical: (option de directive) :type: (option de directive) :value: (option de directive) py:class (directive) :abstract: (option de directive) :canonical: (option de directive) :final: (option de directive) :single-line-parameter-list: (option de directive) :single-line-type-parameter-list: (option de directive) py:class (role) py:classmethod (directive) py:const (role) py:currentmodule (directive) py:data (directive) :canonical: (option de directive) :type: (option de directive) :value: (option de directive)

py:data (role) py:deco (role) py:decorator (directive) :single-line-parameter-list: (option de directive) :single-line-type-parameter-list: (option de directive) py:decoratormethod (directive) py:exc (role) py:exception (directive) :final: (option de directive) :single-line-parameter-list: (option de directive) :single-line-type-parameter-list: (option de directive) py:func (role) py:function (directive) :async: (option de directive) :canonical: (option de directive) :single-line-parameter-list: (option de directive) :single-line-type-parameter-list: (option de directive) py:meth (role) py:method (directive) :abstract: (option de directive) :abstractmethod: (option de directive) :async: (option de directive) :canonical: (option de directive) :classmethod: (option de directive) :final: (option de directive) :single-line-parameter-list: (option de directive) :single-line-type-parameter-list: (option de directive) :staticmethod: (option de directive) py:mod (role) py:module (directive) :deprecated: (option de directive) :platform: (option de directive) :synopsis: (option de directive) py:obj (role) py:property (directive) :abstract: (option de directive) :abstractmethod: (option de directive) :classmethod: (option de directive) :type: (option de directive) py:staticmethod (directive) py:type (directive) :canonical: (option de directive) py:type (role) pygments_style valeur de configuration 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 valeur de configuration python_maximum_signature_line_length valeur de configuration python_trailing_comma_in_multi_line_signatures valeur de configuration python_use_unqualified_type_names valeur de configuration PythonDomain (classe dans sphinx.domains.python) PyType_GenericAlloc (C function)

Q

qthelp_basename valeur de configuration qthelp_namespace valeur de configuration qthelp_theme valeur de configuration

qthelp_theme_options valeur de configuration QtHelpBuilder (classe dans sphinxcontrib.qthelp) qualifier (attribut sphinx.domains.IndexEntry) query() (méthode sphinxcontrib.websupport.search.BaseSearch)

R

:recursive: (option de directive) autosummary (directive) :reversed: (option de directive) toctree (directive) rawtext (attribut sphinx.util.docutils.SphinxRole) read() (méthode sphinx.builders.Builder) read_doc() (méthode sphinx.builders.Builder) ref (role) ReferenceRole (classe dans sphinx.util.docutils) regexp (role) relbar() built-in function reldelim1 (variable de base) reldelim2 (variable de base) release valeur de configuration release (variable de base) relfn2path() (méthode sphinx.environment.BuildEnvironment) rellinks (variable de base) removed in version RemoveInSphinxXXXWarning render() (méthode sphinx.application.TemplateBridge) render_string() (méthode sphinx.application.TemplateBridge) require_sphinx() (méthode statique sphinx.application.Sphinx) required_arguments (attribut docutils.parsers.rst.Directive) (attribut sphinx.directives.ObjectDescription) resolve_any_xref() (méthode sphinx.domains.Domain) resolve_xref() (méthode sphinx.domains.Domain) restore() (méthode sphinx.project.Project) reStructuredText

répertoire de configuration répertoire source RFC RFC 2324 RFC 3986 Section 4.4, [1] RFC 6596 RFC 8081 rfc (role) role role() (méthode sphinx.domains.Domain) roles (attribut sphinx.domains.Domain) root_doc valeur de configuration root_doc (variable de base) rst:dir (role) rst:directive (directive) rst:directive:option (directive) :type: (option de directive) rst:role (directive) (role) rst_epilog valeur de configuration rst_prolog valeur de configuration rubric (directive) :class: (option de directive) :heading-level: (option de directive) :name: (option de directive) run() (méthode docutils.parsers.rst.Directive) (méthode sphinx.directives.ObjectDescription) (méthode sphinx.transforms.post_transforms.SphinxPostTransform)

S

:show-inheritance: (option de directive) autoclass (directive) automodule (directive) :signatures: (option de directive) autosummary (directive) :single-line-parameter-list: (option de directive) c:function (directive) c:macro (directive) cpp:function (directive) js:class (directive) js:function (directive) js:method (directive) py:class (directive) py:decorator (directive) py:exception (directive) py:function (directive) py:method (directive) :single-line-type-parameter-list: (option de directive) py:class (directive) py:decorator (directive) py:exception (directive) py:function (directive) py:method (directive) :skipif: (option de directive) doctest (directive) testcleanup (directive) testcode (directive) testoutput (directive) testsetup (directive) :sorted: (option de directive) glossary (directive) :special-members: (option de directive) autoclass (directive) automodule (directive) :start-after: (option de directive) literalinclude (directive) :start-at: (option de directive) literalinclude (directive) :staticmethod: (option de directive) py:method (directive) :synopsis: (option de directive) automodule (directive) py:module (directive) samp (role) script_files (variable de base) search toctree searchindex_filename (attribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) sectionauthor (directive) seealso (classe dans sphinx.addnodes) (directive) SerializingHTMLBuilder (classe dans sphinxcontrib.serializinghtml) set_application() (méthode sphinx.parsers.Parser) set_html_assets_policy() (méthode sphinx.application.Sphinx) set_source_info() (méthode sphinx.util.docutils.SphinxDirective) set_translator() (méthode sphinx.application.Sphinx) setup() (méthode sphinx.domains.Domain) setup_extension() (méthode sphinx.application.Sphinx) shorttitle (variable de base) show_authors valeur de configuration show_source (variable de base) show_warning_types valeur de configuration sidebar() built-in function SIG_ELEMENTS (dans le module sphinx.addnodes) SingleFileHTMLBuilder (classe dans sphinx.builders.singlehtml) singlehtml_sidebars valeur de configuration smartquotes valeur de configuration smartquotes_action valeur de configuration smartquotes_excludes valeur de configuration snippets testing source-read event source_encoding valeur de configuration source_suffix valeur de configuration source_suffix (attribut sphinx.project.Project) sourcecode (directive) sourcename (variable de base) Sphinx (classe dans sphinx.application) 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 (variable de base) sphinx_version_tuple (variable de base) sphinxcontrib.applehelp module sphinxcontrib.devhelp module sphinxcontrib.htmlhelp module sphinxcontrib.jsmath module sphinxcontrib.qthelp module SphinxDirective (classe dans sphinx.util.docutils) SphinxError SphinxLoggerAdapter (classe dans sphinx.util.logging) SphinxPostTransform (classe dans sphinx.transforms.post_transforms) SphinxRole (classe dans sphinx.util.docutils) SphinxTransform (classe dans sphinx.transforms) srcdir (attribut sphinx.application.Sphinx) (attribut sphinx.environment.BuildEnvironment) (attribut sphinx.project.Project) StandaloneHTMLBuilder (classe dans sphinx.builders.html) start_of_file (classe dans sphinx.addnodes) state (attribut docutils.parsers.rst.Directive) state_machine (attribut docutils.parsers.rst.Directive) StorageBackend (classe dans sphinxcontrib.websupport.storage) strip_signature_backslash valeur de configuration styles (variable de base) substitutions global, [1], [2] subtype (attribut sphinx.domains.IndexEntry) supported_data_uri_images (attribut sphinx.builders.Builder) supported_image_types (attribut sphinx.builders.Builder) (attribut sphinx.builders.changes.ChangesBuilder) (attribut sphinx.builders.dirhtml.DirectoryHTMLBuilder) (attribut sphinx.builders.dummy.DummyBuilder) (attribut sphinx.builders.epub3.Epub3Builder) (attribut sphinx.builders.gettext.MessageCatalogBuilder) (attribut sphinx.builders.html.StandaloneHTMLBuilder) (attribut sphinx.builders.latex.LaTeXBuilder) (attribut sphinx.builders.linkcheck.CheckExternalLinksBuilder) (attribut sphinx.builders.manpage.ManualPageBuilder) (attribut sphinx.builders.singlehtml.SingleFileHTMLBuilder) (attribut sphinx.builders.texinfo.TexinfoBuilder) (attribut sphinx.builders.text.TextBuilder) (attribut sphinx.builders.xml.PseudoXMLBuilder) (attribut sphinx.builders.xml.XMLBuilder) (attribut sphinxcontrib.applehelp.AppleHelpBuilder) (attribut sphinxcontrib.devhelp.DevhelpBuilder) (attribut sphinxcontrib.htmlhelp.HTMLHelpBuilder) (attribut sphinxcontrib.qthelp.QtHelpBuilder) (attribut sphinxcontrib.serializinghtml.JSONHTMLBuilder) (attribut sphinxcontrib.serializinghtml.PickleHTMLBuilder) supported_linkcode (attribut sphinx.builders.Builder) supported_remote_images (attribut sphinx.builders.Builder) suppress_warnings valeur de configuration

T

:tab-width: (option de directive) literalinclude (directive) :template: (option de directive) autosummary (directive) :titlesonly: (option de directive) toctree (directive) :toctree: (option de directive) autosummary (directive) :trim-doctest-flags: (option de directive) doctest (directive) testcode (directive) testoutput (directive) :type: (option de directive) confval (directive) py:attribute (directive) py:data (directive) py:property (directive) rst:directive:option (directive) table of contents tabularcolumns (directive) target (attribut sphinx.util.docutils.ReferenceRole) template_bridge valeur de configuration TemplateBridge (classe dans sphinx.application) templates_path valeur de configuration term (role) testcleanup (directive) :skipif: (option de directive) testcode (directive) :hide: (option de directive) :no-trim-doctest-flags: (option de directive) :skipif: (option de directive) :trim-doctest-flags: (option de directive) testing automatic snippets testoutput (directive) :hide: (option de directive) :no-trim-doctest-flags: (option de directive) :options: (option de directive) :skipif: (option de directive) :trim-doctest-flags: (option de directive) testsetup (directive) :skipif: (option de directive) texinfo_appendices valeur de configuration texinfo_cross_references valeur de configuration texinfo_documents valeur de configuration texinfo_domain_indices valeur de configuration texinfo_elements valeur de configuration texinfo_no_detailmenu valeur de configuration texinfo_show_urls valeur de configuration TexinfoBuilder (classe dans sphinx.builders.texinfo) text (attribut sphinx.util.docutils.SphinxRole) text_add_secnumbers valeur de configuration

text_newlines valeur de configuration text_secnumber_suffix valeur de configuration text_sectionchars valeur de configuration TextBuilder (classe dans sphinx.builders.text) the_answer valeur de configuration ThemeError tip admonition tip (directive) title (attribut sphinx.util.docutils.ReferenceRole) (variable de base) titles (attribut sphinx.environment.BuildEnvironment) tls_cacerts valeur de configuration tls_verify valeur de configuration toc (variable de base) toc_object_entries valeur de configuration toc_object_entries_show_parents valeur de configuration toctree genindex modindex search toctree (classe dans sphinx.addnodes) toctree (directive) (variable de base) :caption: (option de directive) :class: (option de directive) :glob: (option de directive) :hidden: (option de directive) :includehidden: (option de directive) :name: (option de directive) :numbered: (option de directive) :reversed: (option de directive) :titlesonly: (option de directive) today valeur de configuration today_fmt valeur de configuration todo (directive) todo-defined event todo_emit_warnings valeur de configuration todo_include_todos valeur de configuration todo_link_only valeur de configuration todolist (directive) token (role) transform_content() (méthode sphinx.directives.ObjectDescription) translation_progress_classes valeur de configuration trim_doctest_flags valeur de configuration trim_footnote_reference_space valeur de configuration

U

:undoc-members: (option de directive) autoclass (directive) automodule (directive) underline (variable de base)

update_username() (méthode sphinxcontrib.websupport.storage.StorageBackend) use_opensearch (variable de base) user_agent valeur de configuration

V

:value: (option de directive) py:attribute (directive) py:data (directive) valeur de configuration 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

variable d'environnement python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS verbose() (méthode sphinx.util.logging.SphinxLoggerAdapter) version valeur de configuration version (attribut sphinx.util.typing.ExtensionMetadata) (variable de base) version-added (directive) version-changed (directive) version-deprecated (directive) version-removed (directive) version_info (dans le module sphinx) versionadded (directive) versionchanged (directive) versionmodified (classe dans sphinx.addnodes) versionremoved (directive) VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub valeur de configuration viewcode_follow_imported_members valeur de configuration viewcode_line_numbers valeur de configuration Vulnérabilités et expositions communes CVE 2020-10735

W

warn-missing-reference event warning admonition warning (directive) warning() built-in function

warning() (méthode sphinx.util.logging.SphinxLoggerAdapter) WebSupport (classe dans sphinxcontrib.websupport) write() (méthode sphinx.builders.Builder) write-started event write_doc() (méthode sphinx.builders.Builder) write_doctree() (méthode sphinx.builders.Builder) write_documents() (méthode sphinx.builders.Builder)

X

xml_pretty valeur de configuration

XMLBuilder (classe dans sphinx.builders.xml)