Índex

Símbols

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

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

_

_() (al mòdul sphinx.locale) __() (al mòdul sphinx.locale)

_object_hierarchy_parts() (mètode sphinx.directives.ObjectDescription) _parser (atribut sphinx.environment.BuildEnvironment.current_document) _toc_entry_name() (mètode sphinx.directives.ObjectDescription)

A

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

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

B

BaseSearch (classe a sphinxcontrib.websupport.search) before_content() (mètode sphinx.directives.ObjectDescription) between() (al mòdul sphinx.ext.autodoc) block_text (atribut docutils.parsers.rst.Directive) body (variable interna) build() (mètode sphinx.builders.Builder) (mètode sphinxcontrib.websupport.WebSupport) build-finished event build_all() (mètode sphinx.builders.Builder) build_specific() (mètode sphinx.builders.Builder) build_update() (mètode sphinx.builders.Builder) BuildEnvironment (classe a sphinx.environment)

builder Builder (classe a sphinx.builders) builder (variable interna) builder-inited event built-in function enumerate() escape() hasdoc() pathto() relbar() sidebar() warning()

C

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

confdir (atribut sphinx.application.Sphinx) config (atribut sphinx.environment.BuildEnvironment) Config (classe a sphinx.config) config (propietat sphinx.parsers.Parser) (propietat sphinx.transforms.SphinxTransform) (propietat sphinx.util.docutils.SphinxDirective) (propietat sphinx.util.docutils.SphinxRole) config-inited event ConfigError configuration directory confval (directiva) :default: (opció de la directiva) :type: (opció de la directiva) confval (rol) connect() (mètode sphinx.application.Sphinx) (mètode sphinx.events.EventManager) content (atribut docutils.parsers.rst.Directive) (atribut sphinx.util.docutils.SphinxRole) content_offset (atribut docutils.parsers.rst.Directive) contents table of conversion_rules (atribut sphinx.transforms.post_transforms.images.ImageConverter) convert() (mètode sphinx.transforms.post_transforms.images.ImageConverter) copy_assets() (mètode sphinx.builders.Builder) copyright valor de configuració copyright (variable interna) coverage_c_path valor de configuració coverage_c_regexes valor de configuració coverage_ignore_c_items valor de configuració coverage_ignore_classes valor de configuració coverage_ignore_functions valor de configuració coverage_ignore_modules valor de configuració coverage_ignore_pyobjects valor de configuració coverage_modules valor de configuració coverage_show_missing_items valor de configuració coverage_skip_undoc_in_source valor de configuració coverage_statistics_to_report valor de configuració coverage_statistics_to_stdout valor de configuració coverage_write_headline valor de configuració CoverageBuilder (classe a sphinx.ext.coverage) cpp:alias (directiva) :maxdepth: (opció de la directiva) :noroot: (opció de la directiva) cpp:any (rol) cpp:class (directiva) (rol) cpp:concept (directiva) (rol) cpp:enum (directiva) (rol) cpp:enum-class (directiva) cpp:enum-struct (directiva) cpp:enumerator (directiva) (rol) cpp:expr (rol) cpp:func (rol) cpp:function (directiva) :single-line-parameter-list: (opció de la directiva) cpp:member (directiva) (rol) cpp:namespace (directiva) cpp:namespace-pop (directiva) cpp:namespace-push (directiva) cpp:struct (directiva) (rol) cpp:texpr (rol) cpp:type (directiva) (rol) cpp:union (directiva) cpp:var (directiva) (rol) cpp_id_attributes valor de configuració cpp_index_common_prefix valor de configuració cpp_maximum_signature_line_length valor de configuració cpp_paren_attributes valor de configuració critical() (mètode sphinx.util.logging.SphinxLoggerAdapter) current_document (atribut sphinx.environment.BuildEnvironment) CustomList (C++ type) cut_lines() (al mòdul sphinx.ext.autodoc) cve (rol) cwe (rol)

D

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

DirectoryHTMLBuilder (classe a sphinx.builders.dirhtml) disabled (atribut sphinx.util.docutils.ReferenceRole) disconnect() (mètode sphinx.application.Sphinx) (mètode sphinx.events.EventManager) discover() (mètode sphinx.project.Project) display_toc (variable interna) doc (rol) doc2path() (mètode sphinx.environment.BuildEnvironment) (mètode sphinx.project.Project) docname (atribut sphinx.domains.IndexEntry) (atribut sphinx.environment.BuildEnvironment) (atribut sphinx.environment.BuildEnvironment.current_document) docnames (atribut sphinx.project.Project) docstitle (variable interna) docstring doctest doctest (directiva) :hide: (opció de la directiva) :no-trim-doctest-flags: (opció de la directiva) :options: (opció de la directiva) :pyversion: (opció de la directiva) :skipif: (opció de la directiva) :trim-doctest-flags: (opció de la directiva) doctest_default_flags valor de configuració doctest_fail_fast valor de configuració doctest_global_cleanup valor de configuració doctest_global_setup valor de configuració doctest_path valor de configuració doctest_show_successes valor de configuració doctest_test_doctest_blocks valor de configuració doctree-read event doctree-resolved event doctreedir (atribut sphinx.application.Sphinx) (atribut sphinx.environment.BuildEnvironment) document name documentation automatic, [1] generate generation docutils.parsers.rst module docutils_version_info (variable interna) domain default Domain (classe a sphinx.domains) download (rol) download_reference (classe a sphinx.addnodes) DummyBuilder (classe a sphinx.builders.dummy) duration_limit valor de configuració duration_n_slowest valor de configuració duration_print_slowest valor de configuració duration_print_total valor de configuració duration_write_json valor de configuració

E

:emphasize-lines: (opció de la directiva) code-block (directiva) literalinclude (directiva) :encoding: (opció de la directiva) literalinclude (directiva) :end-at: (opció de la directiva) literalinclude (directiva) :end-before: (opció de la directiva) literalinclude (directiva) :exclude-members: (opció de la directiva) autoclass (directiva) automodule (directiva) embedded (variable interna) emit() (mètode sphinx.application.Sphinx) (mètode sphinx.events.EventManager) emit_firstresult() (mètode sphinx.application.Sphinx) (mètode sphinx.events.EventManager) ENUM (classe a sphinx.config) enumerable_nodes (atribut sphinx.domains.Domain) Enumeració de les debilitats comunes (CWE 787) enumerate() built-in function env (propietat sphinx.parsers.Parser) (propietat sphinx.transforms.SphinxTransform) (propietat sphinx.util.docutils.SphinxDirective) (propietat 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 (atribut sphinx.util.typing.ExtensionMetadata) environment EnvironmentCollector (classe a sphinx.environment.collectors) envvar (directiva) (rol) epilog (atribut sphinx.builders.Builder) Epub3Builder (classe a sphinx.builders.epub3) epub_author valor de configuració epub_basename valor de configuració epub_contributor valor de configuració epub_copyright valor de configuració epub_cover valor de configuració epub_css_files valor de configuració epub_description valor de configuració epub_exclude_files valor de configuració epub_fix_images valor de configuració epub_guide valor de configuració epub_identifier valor de configuració epub_language valor de configuració epub_max_image_width valor de configuració epub_post_files valor de configuració epub_pre_files valor de configuració epub_publisher valor de configuració

epub_scheme valor de configuració epub_show_urls valor de configuració epub_theme valor de configuració epub_theme_options valor de configuració epub_title valor de configuració epub_tocdepth valor de configuració epub_tocdup valor de configuració epub_tocscope valor de configuració epub_uid valor de configuració epub_use_index valor de configuració epub_writing_mode valor de configuració eq (rol) error admonition error (directiva) error() (mètode 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 a sphinx.events) events (atribut sphinx.builders.Builder) (atribut sphinx.environment.BuildEnvironment) examples code exceptions (variable interna) exclude_patterns valor de configuració extension ExtensionError, [1] ExtensionMetadata (classe a sphinx.util.typing) extensions valor de configuració external (rol) extlinks valor de configuració extlinks_detect_hardcoded_links valor de configuració extra (atribut sphinx.domains.IndexEntry) extract_context() (mètode sphinxcontrib.websupport.search.BaseSearch)

F

:final: (opció de la directiva) py:class (directiva) py:exception (directiva) py:method (directiva) :force: (opció de la directiva) code-block (directiva) highlight (directiva) literalinclude (directiva) favicon_url (variable interna) feed() (mètode sphinxcontrib.websupport.search.BaseSearch) figure_language_filename valor de configuració file (rol) file_suffix (variable interna) final_argument_whitespace (atribut docutils.parsers.rst.Directive) (atribut sphinx.directives.ObjectDescription) finish() (mètode sphinx.builders.Builder) finish_indexing() (mètode sphinxcontrib.websupport.search.BaseSearch) format (atribut sphinx.builders.Builder) (atribut sphinx.builders.changes.ChangesBuilder) (atribut sphinx.builders.dirhtml.DirectoryHTMLBuilder) (atribut sphinx.builders.epub3.Epub3Builder) (atribut sphinx.builders.gettext.MessageCatalogBuilder) (atribut sphinx.builders.html.StandaloneHTMLBuilder) (atribut sphinx.builders.latex.LaTeXBuilder) (atribut sphinx.builders.linkcheck.CheckExternalLinksBuilder) (atribut sphinx.builders.manpage.ManualPageBuilder) (atribut sphinx.builders.singlehtml.SingleFileHTMLBuilder) (atribut sphinx.builders.texinfo.TexinfoBuilder) (atribut sphinx.builders.text.TextBuilder) (atribut sphinx.builders.xml.PseudoXMLBuilder) (atribut sphinx.builders.xml.XMLBuilder) (atribut sphinxcontrib.applehelp.AppleHelpBuilder) (atribut sphinxcontrib.devhelp.DevhelpBuilder) (atribut sphinxcontrib.htmlhelp.HTMLHelpBuilder) (atribut sphinxcontrib.qthelp.QtHelpBuilder) (atribut sphinxcontrib.serializinghtml.JSONHTMLBuilder) (atribut sphinxcontrib.serializinghtml.PickleHTMLBuilder)

found_docs (atribut sphinx.environment.BuildEnvironment) fresh_env_used (atribut sphinx.application.Sphinx) fullname (variable interna) functions (variable interna)

G

:glob: (opció de la directiva) toctree (directiva) generate documentation generate() (mètode sphinx.domains.Index) generation documentation genindex toctree get_data() (mètode sphinxcontrib.websupport.storage.StorageBackend) (mètode sphinxcontrib.websupport.WebSupport) get_document() (mètode sphinxcontrib.websupport.WebSupport) get_enumerable_node_type() (mètode sphinx.domains.Domain) get_full_qualified_name() (mètode sphinx.domains.Domain) get_location() (mètode sphinx.util.docutils.SphinxDirective) (mètode sphinx.util.docutils.SphinxRole) get_objects() (mètode sphinx.domains.Domain) get_outdated_docs() (mètode sphinx.builders.Builder) (mètode sphinx.environment.collectors.EnvironmentCollector) get_relative_uri() (mètode sphinx.builders.Builder) get_search_results() (mètode sphinxcontrib.websupport.WebSupport) get_signatures() (mètode sphinx.directives.ObjectDescription) get_source_info() (mètode sphinx.util.docutils.SphinxDirective) get_target_uri() (mètode sphinx.builders.Builder) get_translation() (al mòdul sphinx.locale) get_type_name() (mètode sphinx.domains.Domain) get_updated_docs() (mètode sphinx.environment.collectors.EnvironmentCollector) getLogger() (al mòdul sphinx.util.logging) gettext_additional_targets valor de configuració gettext_allow_fuzzy_translations valor de configuració gettext_auto_build valor de configuració

gettext_compact valor de configuració gettext_location valor de configuració gettext_uuid valor de configuració global substitutions, [1], [2] globalcontext_filename (atribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) glossary (classe a sphinx.addnodes) glossary (directiva) :sorted: (opció de la directiva) graph (directiva) :align: (opció de la directiva) :alt: (opció de la directiva) :caption: (opció de la directiva) :class: (opció de la directiva) :layout: (opció de la directiva) :name: (opció de la directiva) graphviz (directiva) :align: (opció de la directiva) :alt: (opció de la directiva) :caption: (opció de la directiva) :class: (opció de la directiva) :layout: (opció de la directiva) :name: (opció de la directiva) graphviz_dot valor de configuració graphviz_dot_args valor de configuració graphviz_output_format valor de configuració guilabel (rol)

H

:heading-level: (opció de la directiva) rubric (directiva) :hidden: (opció de la directiva) toctree (directiva) :hide: (opció de la directiva) doctest (directiva) testcode (directiva) testoutput (directiva) handle_query() (mètode sphinxcontrib.websupport.search.BaseSearch) handle_signature() (mètode sphinx.directives.ObjectDescription) has_content (atribut docutils.parsers.rst.Directive) (atribut sphinx.directives.ObjectDescription) has_explicit_title (atribut sphinx.util.docutils.ReferenceRole) has_source (variable interna) hasdoc() built-in function highlight (directiva) :force: (opció de la directiva) :linenothreshold: (opció de la directiva) highlight_language valor de configuració highlight_language (atribut sphinx.environment.BuildEnvironment.current_document) highlight_options valor de configuració highlightlang (classe a sphinx.addnodes) hint admonition hint (directiva) hlist (directiva) :columns: (opció de la directiva) html-collect-pages event html-page-context event html_additional_pages valor de configuració html_baseurl valor de configuració html_codeblock_linenos_style valor de configuració html_compact_lists valor de configuració html_context valor de configuració html_copy_source valor de configuració html_css_files valor de configuració html_domain_indices valor de configuració html_extra_path valor de configuració html_favicon valor de configuració html_file_suffix valor de configuració html_js_files valor de configuració html_last_updated_fmt valor de configuració html_last_updated_use_utc valor de configuració

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

I

:ignore-module-all: (opció de la directiva) automodule (directiva) :imported-members: (opció de la directiva) automodule (directiva) :include-subclasses: (opció de la directiva) inheritance-diagram (directiva) :includehidden: (opció de la directiva) toctree (directiva) :inherited-members: (opció de la directiva) autoclass (directiva) ifconfig (directiva) image_converter valor de configuració image_converter_args valor de configuració ImageConverter (classe a sphinx.transforms.post_transforms.images) imgmath_add_tooltips valor de configuració imgmath_dvipng valor de configuració imgmath_dvipng_args valor de configuració imgmath_dvisvgm valor de configuració imgmath_dvisvgm_args valor de configuració imgmath_embed valor de configuració imgmath_font_size valor de configuració imgmath_image_format valor de configuració imgmath_latex valor de configuració imgmath_latex_args valor de configuració imgmath_latex_preamble valor de configuració imgmath_use_preview valor de configuració implementation (atribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) important admonition important (directiva) in version added changes removed

include-read event include_patterns valor de configuració index (classe a sphinx.addnodes) Index (classe a sphinx.domains) index (directiva) :name: (opció de la directiva) index (rol) IndexEntry (classe a sphinx.domains) indices (atribut sphinx.domains.Domain) info() (mètode sphinx.util.logging.SphinxLoggerAdapter) inheritance-diagram (directiva) :include-subclasses: (opció de la directiva) inheritance_alias valor de configuració inheritance_edge_attrs valor de configuració inheritance_graph_attrs valor de configuració inheritance_node_attrs valor de configuració inherited_members (variable interna) init() (al mòdul sphinx.locale) (mètode sphinx.application.TemplateBridge) (mètode sphinx.builders.Builder) init_console() (al mòdul sphinx.locale) init_indexing() (mètode sphinxcontrib.websupport.search.BaseSearch) initial_data (atribut sphinx.domains.Domain) inliner (atribut sphinx.util.docutils.SphinxRole) intersphinx_cache_limit valor de configuració intersphinx_disabled_reftypes valor de configuració intersphinx_mapping valor de configuració intersphinx_resolve_self valor de configuració intersphinx_timeout valor de configuració is_available() (mètode sphinx.transforms.post_transforms.images.ImageConverter) is_parallel_allowed() (mètode sphinx.application.Sphinx) is_supported() (mètode sphinx.transforms.post_transforms.SphinxPostTransform)

J

javascript_maximum_signature_line_length valor de configuració javascript_trailing_comma_in_multi_line_signatures valor de configuració js:attr (rol) js:attribute (directiva) js:class (directiva) :single-line-parameter-list: (opció de la directiva) js:class (rol) js:data (directiva) (rol)

js:func (rol) js:function (directiva) :single-line-parameter-list: (opció de la directiva) js:meth (rol) js:method (directiva) :single-line-parameter-list: (opció de la directiva) js:mod (rol) js:module (directiva) jsmath_path valor de configuració JSONHTMLBuilder (classe a sphinxcontrib.serializinghtml)

K

kbd (rol) keep_warnings valor de configuració

keyword (rol)

L

:label: (opció de la directiva) math (directiva) :language: (opció de la directiva) literalinclude (directiva) :layout: (opció de la directiva) digraph (directiva) graph (directiva) graphviz (directiva) :lineno-match: (opció de la directiva) literalinclude (directiva) :lineno-start: (opció de la directiva) code-block (directiva) literalinclude (directiva) :linenos: (opció de la directiva) code-block (directiva) literalinclude (directiva) :linenothreshold: (opció de la directiva) highlight (directiva) :lines: (opció de la directiva) literalinclude (directiva) label (atribut sphinx.domains.Domain) language valor de configuració language (variable interna) last_updated (variable interna) latex module latex_additional_files valor de configuració latex_appendices valor de configuració latex_docclass valor de configuració latex_documents valor de configuració latex_domain_indices valor de configuració latex_elements valor de configuració latex_engine valor de configuració latex_logo valor de configuració latex_show_pagerefs valor de configuració latex_show_urls valor de configuració latex_table_style valor de configuració latex_theme valor de configuració latex_theme_options valor de configuració latex_theme_path valor de configuració latex_toplevel_sectioning valor de configuració latex_use_latex_multicolumn valor de configuració latex_use_xindy valor de configuració LaTeXBuilder (classe a sphinx.builders.latex) lineno (atribut docutils.parsers.rst.Directive) (atribut sphinx.util.docutils.SphinxRole)

linkcheck-process-uri event linkcheck_allow_unauthorized valor de configuració linkcheck_allowed_redirects valor de configuració linkcheck_anchors valor de configuració linkcheck_anchors_ignore valor de configuració linkcheck_anchors_ignore_for_url valor de configuració linkcheck_auth valor de configuració linkcheck_case_insensitive_urls valor de configuració linkcheck_exclude_documents valor de configuració linkcheck_ignore valor de configuració linkcheck_rate_limit_timeout valor de configuració linkcheck_report_timeouts_as_broken valor de configuració linkcheck_request_headers valor de configuració linkcheck_retries valor de configuració linkcheck_timeout valor de configuració linkcheck_workers valor de configuració linkcode_resolve valor de configuració linking automatic literal_emphasis (classe a sphinx.addnodes) literalinclude (directiva) :append: (opció de la directiva) :caption: (opció de la directiva) :class: (opció de la directiva) :dedent: (opció de la directiva) :diff: (opció de la directiva) :emphasize-lines: (opció de la directiva) :encoding: (opció de la directiva) :end-at: (opció de la directiva) :end-before: (opció de la directiva) :force: (opció de la directiva) :language: (opció de la directiva) :lineno-match: (opció de la directiva) :lineno-start: (opció de la directiva) :linenos: (opció de la directiva) :lines: (opció de la directiva) :name: (opció de la directiva) :prepend: (opció de la directiva) :pyobject: (opció de la directiva) :start-after: (opció de la directiva) :start-at: (opció de la directiva) :tab-width: (opció de la directiva) locale_dirs valor de configuració log() (mètode sphinx.util.logging.SphinxLoggerAdapter) logo_url (variable interna)

M

:maxdepth: (opció de la directiva) c:alias (directiva) cpp:alias (directiva) :member-order: (opció de la directiva) autoclass (directiva) automodule (directiva) :members: (opció de la directiva) autoclass (directiva) automodule (directiva) mailheader (rol) makevar (rol) man_make_section_directory valor de configuració man_pages valor de configuració man_show_urls valor de configuració manpage (rol) manpages_url valor de configuració ManualPageBuilder (classe a sphinx.builders.manpage) master document master_doc valor de configuració master_doc (variable interna) math (directiva) :class: (opció de la directiva) :label: (opció de la directiva) :name: (opció de la directiva) :no-wrap: (opció de la directiva) math (rol) math:numref (rol) math_eqref_format valor de configuració math_number_all valor de configuració math_numfig valor de configuració math_numsep valor de configuració mathjax2_config valor de configuració mathjax3_config valor de configuració mathjax4_config valor de configuració mathjax_config valor de configuració mathjax_config_path valor de configuració mathjax_options valor de configuració mathjax_path valor de configuració maximum_signature_line_length valor de configuració members (variable interna) menuselection (rol) merge_domaindata() (mètode sphinx.domains.Domain) merge_other() (mètode sphinx.environment.collectors.EnvironmentCollector) MessageCatalogBuilder (classe a sphinx.builders.gettext) meta (variable interna) metadata (atribut sphinx.environment.BuildEnvironment) metatags (variable interna) methods (variable interna)

mimetype (rol) missing-reference event modindex toctree modindex_common_prefix valor de configuració 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 interna) modules (atribut sphinx.domains.python.PythonDomain) (variable interna)

N

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

napoleon_attr_annotations valor de configuració napoleon_custom_sections valor de configuració napoleon_google_docstring valor de configuració napoleon_include_init_with_doc valor de configuració napoleon_include_private_with_doc valor de configuració napoleon_include_special_with_doc valor de configuració napoleon_numpy_docstring valor de configuració napoleon_preprocess_types valor de configuració napoleon_type_aliases valor de configuració napoleon_use_admonition_for_examples valor de configuració napoleon_use_admonition_for_notes valor de configuració napoleon_use_admonition_for_references valor de configuració napoleon_use_ivar valor de configuració napoleon_use_keyword valor de configuració napoleon_use_param valor de configuració napoleon_use_rtype valor de configuració needs_extensions valor de configuració needs_sphinx valor de configuració nested_parse_to_nodes() (al mòdul sphinx.util.parsing) new_serialno() (mètode sphinx.environment.BuildEnvironment) newest_template_mtime() (mètode sphinx.application.TemplateBridge) newsgroup (rol) next (variable interna) nitpick_ignore valor de configuració nitpick_ignore_regex valor de configuració nitpicky valor de configuració note admonition note (directiva) note_dependency() (mètode sphinx.environment.BuildEnvironment) note_module() (mètode sphinx.domains.python.PythonDomain) note_object() (mètode sphinx.domains.python.PythonDomain) note_reread() (mètode sphinx.environment.BuildEnvironment) numfig valor de configuració numfig_format valor de configuració numfig_secnum_depth valor de configuració numref (rol)

O

:options: (opció de la directiva) doctest (directiva) testoutput (directiva) object (directiva) object-description-transform event object_types (atribut sphinx.domains.Domain) ObjectDescription (classe a sphinx.directives) objects (atribut sphinx.domains.python.PythonDomain) objname (variable interna) ObjType (classe a sphinx.domains) objtype (variable interna) only (classe a sphinx.addnodes) (directiva) opció de la línia d'ordres 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 opció de la línia d'ordres sphinx-autogen --imported-members --remove-old --respect-module-all --suffix --templates -a -i -o -s -t opció de la línia d'ordres 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

opció de la línia d'ordres 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 (directiva) (rol) option_emphasise_placeholders valor de configuració option_spec (atribut docutils.parsers.rst.Directive) (atribut sphinx.directives.ObjectDescription) optional_arguments (atribut docutils.parsers.rst.Directive) (atribut sphinx.directives.ObjectDescription) options (atribut docutils.parsers.rst.Directive) (atribut sphinx.util.docutils.SphinxRole) out_suffix (atribut sphinxcontrib.serializinghtml.SerializingHTMLBuilder) outdir (atribut sphinx.application.Sphinx)

P

:platform: (opció de la directiva) automodule (directiva) py:module (directiva) :prepend: (opció de la directiva) literalinclude (directiva) :private-members: (opció de la directiva) autoclass (directiva) automodule (directiva) :pyobject: (opció de la directiva) literalinclude (directiva) :pyversion: (opció de la directiva) doctest (directiva) page_source_suffix (variable interna) pagename (variable interna) parallel_read_safe (atribut sphinx.util.typing.ExtensionMetadata) parallel_write_safe (atribut sphinx.util.typing.ExtensionMetadata) parents (variable interna) parse_content_to_nodes() (mètode sphinx.util.docutils.SphinxDirective) parse_inline() (mètode sphinx.util.docutils.SphinxDirective) parse_text_to_nodes() (mètode sphinx.util.docutils.SphinxDirective) parser (atribut sphinx.environment.BuildEnvironment) Parser (classe a sphinx.parsers) path2doc() (mètode sphinx.project.Project) pathto() built-in function pending_logging() (al mòdul sphinx.util.logging) pending_warnings() (al mòdul sphinx.util.logging) pending_xref (classe a sphinx.addnodes) pending_xref_condition (classe a sphinx.addnodes) pep (rol) PickleHTMLBuilder (classe a sphinxcontrib.serializinghtml) post_build() (mètode sphinxcontrib.websupport.storage.StorageBackend) pre_build() (mètode sphinxcontrib.websupport.storage.StorageBackend) prefixed_warnings() (al mòdul sphinx.util.logging) prepare_writing() (mètode sphinx.builders.Builder) prev (variable interna) primary_domain valor de configuració process_doc() (mètode sphinx.domains.Domain) (mètode sphinx.environment.collectors.EnvironmentCollector) process_field_xref() (mètode sphinx.domains.Domain) process_vote() (mètode sphinxcontrib.websupport.storage.StorageBackend) (mètode sphinxcontrib.websupport.WebSupport) production (classe a sphinx.addnodes) productionlist (classe a sphinx.addnodes) (directiva) program (directiva) (rol) project valor de configuració project (atribut sphinx.application.Sphinx) (atribut sphinx.environment.BuildEnvironment) Project (classe a sphinx.project) project (variable interna) project_copyright valor de configuració Propostes de millora a Python (PEP 257#what-is-a-docstring) (PEP 287) (PEP 420), [1], [2] (PEP 440#version-specifiers) (PEP 440) (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) PseudoXMLBuilder (classe a sphinx.builders.xml) py:attr (rol) py:attribute (directiva) :canonical: (opció de la directiva) :type: (opció de la directiva) :value: (opció de la directiva)

py:class (directiva) :abstract: (opció de la directiva) :canonical: (opció de la directiva) :final: (opció de la directiva) :single-line-parameter-list: (opció de la directiva) :single-line-type-parameter-list: (opció de la directiva) py:class (rol) py:classmethod (directiva) py:const (rol) py:currentmodule (directiva) py:data (directiva) :canonical: (opció de la directiva) :type: (opció de la directiva) :value: (opció de la directiva) py:data (rol) py:deco (rol) py:decorator (directiva) :single-line-parameter-list: (opció de la directiva) :single-line-type-parameter-list: (opció de la directiva) py:decoratormethod (directiva) py:exc (rol) py:exception (directiva) :final: (opció de la directiva) :single-line-parameter-list: (opció de la directiva) :single-line-type-parameter-list: (opció de la directiva) py:func (rol) py:function (directiva) :async: (opció de la directiva) :canonical: (opció de la directiva) :single-line-parameter-list: (opció de la directiva) :single-line-type-parameter-list: (opció de la directiva) py:meth (rol) py:method (directiva) :abstract: (opció de la directiva) :abstractmethod: (opció de la directiva) :async: (opció de la directiva) :canonical: (opció de la directiva) :classmethod: (opció de la directiva) :final: (opció de la directiva) :single-line-parameter-list: (opció de la directiva) :single-line-type-parameter-list: (opció de la directiva) :staticmethod: (opció de la directiva) py:mod (rol) py:module (directiva) :deprecated: (opció de la directiva) :platform: (opció de la directiva) :synopsis: (opció de la directiva) py:obj (rol) py:property (directiva) :abstract: (opció de la directiva) :abstractmethod: (opció de la directiva) :classmethod: (opció de la directiva) :type: (opció de la directiva) py:staticmethod (directiva) py:type (directiva) :canonical: (opció de la directiva) py:type (rol) pygments_style valor de configuració python:PYTHONWARNINGS python_display_short_literal_types valor de configuració python_maximum_signature_line_length valor de configuració python_trailing_comma_in_multi_line_signatures valor de configuració python_use_unqualified_type_names valor de configuració PythonDomain (classe a sphinx.domains.python) PyType_GenericAlloc (C function)

Q

qthelp_basename valor de configuració qthelp_namespace valor de configuració qthelp_theme valor de configuració

qthelp_theme_options valor de configuració QtHelpBuilder (classe a sphinxcontrib.qthelp) qualifier (atribut sphinx.domains.IndexEntry) query() (mètode sphinxcontrib.websupport.search.BaseSearch)

R

:recursive: (opció de la directiva) autosummary (directiva) :reversed: (opció de la directiva) toctree (directiva) rawtext (atribut sphinx.util.docutils.SphinxRole) read() (mètode sphinx.builders.Builder) read_doc() (mètode sphinx.builders.Builder) ref (rol) ReferenceRole (classe a sphinx.util.docutils) regexp (rol) relbar() built-in function reldelim1 (variable interna) reldelim2 (variable interna) release valor de configuració release (variable interna) relfn2path() (mètode sphinx.environment.BuildEnvironment) rellinks (variable interna) removed in version RemoveInSphinxXXXWarning render() (mètode sphinx.application.TemplateBridge) render_string() (mètode sphinx.application.TemplateBridge) require_sphinx() (mètode estàtic sphinx.application.Sphinx) required_arguments (atribut docutils.parsers.rst.Directive) (atribut sphinx.directives.ObjectDescription) resolve_any_xref() (mètode sphinx.domains.Domain) resolve_xref() (mètode sphinx.domains.Domain) restore() (mètode sphinx.project.Project)

reStructuredText RFC RFC 2324 RFC 3986 Section 4.4, [1] RFC 6596 RFC 8081 rfc (rol) role role() (mètode sphinx.domains.Domain) roles (atribut sphinx.domains.Domain) root document root_doc valor de configuració root_doc (variable interna) rst:dir (rol) rst:directive (directiva) rst:directive:option (directiva) :type: (opció de la directiva) rst:role (directiva) (rol) rst_epilog valor de configuració rst_prolog valor de configuració rubric (directiva) :class: (opció de la directiva) :heading-level: (opció de la directiva) :name: (opció de la directiva) run() (mètode docutils.parsers.rst.Directive) (mètode sphinx.directives.ObjectDescription) (mètode sphinx.transforms.post_transforms.SphinxPostTransform)

S

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

T

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

text_newlines valor de configuració text_secnumber_suffix valor de configuració text_sectionchars valor de configuració TextBuilder (classe a sphinx.builders.text) the_answer valor de configuració ThemeError tip admonition tip (directiva) title (atribut sphinx.util.docutils.ReferenceRole) (variable interna) titles (atribut sphinx.environment.BuildEnvironment) tls_cacerts valor de configuració tls_verify valor de configuració toc (variable interna) toc_object_entries valor de configuració toc_object_entries_show_parents valor de configuració toctree genindex modindex search toctree (classe a sphinx.addnodes) toctree (directiva) (variable interna) :caption: (opció de la directiva) :class: (opció de la directiva) :glob: (opció de la directiva) :hidden: (opció de la directiva) :includehidden: (opció de la directiva) :name: (opció de la directiva) :numbered: (opció de la directiva) :reversed: (opció de la directiva) :titlesonly: (opció de la directiva) today valor de configuració today_fmt valor de configuració todo (directiva) todo-defined event todo_emit_warnings valor de configuració todo_include_todos valor de configuració todo_link_only valor de configuració todolist (directiva) token (rol) transform_content() (mètode sphinx.directives.ObjectDescription) translation_progress_classes valor de configuració trim_doctest_flags valor de configuració trim_footnote_reference_space valor de configuració

U

:undoc-members: (opció de la directiva) autoclass (directiva) automodule (directiva) underline (variable interna)

update_username() (mètode sphinxcontrib.websupport.storage.StorageBackend) use_opensearch (variable interna) user_agent valor de configuració

V

:value: (opció de la directiva) py:attribute (directiva) py:data (directiva) valor de configuració 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'entorn python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS verbose() (mètode sphinx.util.logging.SphinxLoggerAdapter) version valor de configuració version (atribut sphinx.util.typing.ExtensionMetadata) (variable interna) version-added (directiva) version-changed (directiva) version-deprecated (directiva) version-removed (directiva) version_info (al mòdul sphinx) versionadded (directiva) versionchanged (directiva) versionmodified (classe a sphinx.addnodes) versionremoved (directiva) VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub valor de configuració viewcode_follow_imported_members valor de configuració viewcode_line_numbers valor de configuració Vulnerabilitats i exposicions comunes (CVE 2020-10735)

W

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

warning() (mètode sphinx.util.logging.SphinxLoggerAdapter) WebSupport (classe a sphinxcontrib.websupport) write() (mètode sphinx.builders.Builder) write-started event write_doc() (mètode sphinx.builders.Builder) write_doctree() (mètode sphinx.builders.Builder) write_documents() (mètode sphinx.builders.Builder)

X

xml_pretty valor de configuració

XMLBuilder (classe a sphinx.builders.xml)