Índice

Símbolos

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

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

_

_() (no módulo sphinx.locale) __() (no módulo sphinx.locale)

_object_hierarchy_parts() (método sphinx.directives.ObjectDescription) _toc_entry_name() (método sphinx.directives.ObjectDescription)

A

:abstractmethod: (opção diretiva) py:method (diretiva) py:property (diretiva) :align: (opção diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) :alt: (opção diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) :async: (opção diretiva) py:function (diretiva) py:method (diretiva) abbr (papel) accept_comment() (método sphinxcontrib.websupport.storage.StorageBackend) add() (método sphinx.events.EventManager) add_autodoc_attrgetter() (método sphinx.application.Sphinx) add_autodocumenter() (método sphinx.application.Sphinx) add_builder() (método sphinx.application.Sphinx) add_comment() (método sphinxcontrib.websupport.storage.StorageBackend) (método sphinxcontrib.websupport.WebSupport) add_config_value() (método sphinx.application.Sphinx) add_crossref_type() (método sphinx.application.Sphinx) add_css_file() (método sphinx.application.Sphinx) add_directive() (método sphinx.application.Sphinx) add_directive_to_domain() (método sphinx.application.Sphinx) add_document() (método sphinxcontrib.websupport.search.BaseSearch) add_domain() (método sphinx.application.Sphinx)

add_enumerable_node() (método sphinx.application.Sphinx) add_env_collector() (método sphinx.application.Sphinx) add_event() (método sphinx.application.Sphinx) add_function_parentheses configuration value add_generic_role() (método sphinx.application.Sphinx) add_html_math_renderer() (método sphinx.application.Sphinx) add_html_theme() (método sphinx.application.Sphinx) add_index_to_domain() (método sphinx.application.Sphinx) add_js_file() (método sphinx.application.Sphinx) add_latex_package() (método sphinx.application.Sphinx) add_lexer() (método sphinx.application.Sphinx) add_message_catalog() (método sphinx.application.Sphinx) add_module_names configuration value add_node() (método sphinx.application.Sphinx) (método sphinxcontrib.websupport.storage.StorageBackend) add_object_type() (método sphinx.application.Sphinx) (método sphinx.domains.Domain) add_post_transform() (método sphinx.application.Sphinx) add_role() (método sphinx.application.Sphinx) add_role_to_domain() (método sphinx.application.Sphinx) add_search_language() (método sphinx.application.Sphinx) add_source_parser() (método sphinx.application.Sphinx) add_source_suffix() (método sphinx.application.Sphinx) add_target_and_index() (método sphinx.directives.ObjectDescription) add_transform() (método sphinx.application.Sphinx) after_content() (método sphinx.directives.ObjectDescription) allow_parallel (atributo sphinx.builders.Builder)

ambiente

A

any (papel) app (atributo sphinx.environment.BuildEnvironment) (propriedade sphinx.transforms.SphinxTransform ) applehelp_bundle_id configuration value applehelp_bundle_name configuration value applehelp_bundle_version configuration value applehelp_codesign_flags configuration value applehelp_codesign_identity configuration value applehelp_codesign_path configuration value applehelp_dev_region configuration value applehelp_disable_external_tools configuration value applehelp_icon configuration value applehelp_index_anchors configuration value applehelp_indexer_path configuration value applehelp_kb_product configuration value applehelp_kb_url configuration value applehelp_locale configuration value applehelp_min_term_length configuration value applehelp_remote_url configuration value applehelp_stopwords configuration value applehelp_title configuration value AppleHelpBuilder (classe em sphinxcontrib.applehelp) apply() (método sphinx.transforms.post_transforms.SphinxPostTransform) arguments (atributo docutils.parsers.rst.Directive) attributes (variável interna) author configuration value autoattribute (diretiva) autoclass (diretiva) autoclass_content configuration value autodata (diretiva) autodecorator (diretiva) autodoc-before-process-signature event autodoc-process-bases event autodoc-process-docstring event autodoc-process-signature event autodoc-skip-member event

autodoc_class_signature configuration value autodoc_default_flags configuration value autodoc_default_options configuration value autodoc_docstring_signature configuration value autodoc_inherit_docstrings configuration value autodoc_member_order configuration value autodoc_mock_imports configuration value autodoc_preserve_defaults configuration value autodoc_type_aliases configuration value autodoc_typehints configuration value autodoc_typehints_description_target configuration value autodoc_typehints_format configuration value autodoc_warningiserror configuration value autoexception (diretiva) autofunction (diretiva) automatic documentation linking testing automethod (diretiva) automodule (diretiva) :members: (opção diretiva) :private-members: (opção diretiva) :special-members: (opção diretiva) :undoc-members: (opção diretiva) autoproperty (diretiva) autosectionlabel_maxdepth configuration value autosectionlabel_prefix_document configuration value autosummary (diretiva) autosummary_context configuration value autosummary_filename_map configuration value autosummary_generate configuration value autosummary_generate_overwrite configuration value autosummary_ignore_module_all configuration value autosummary_imported_members configuration value autosummary_mock_imports configuration value available (atributo sphinx.transforms.post_transforms.images.ImageConverter)

B

BaseSearch (classe em sphinxcontrib.websupport.search) before_content() (método sphinx.directives.ObjectDescription) between() (no módulo sphinx.ext.autodoc) block_text (atributo docutils.parsers.rst.Directive) body (variável interna) build() (método sphinx.builders.Builder) (método sphinxcontrib.websupport.WebSupport) build-finished event build_all() (método sphinx.builders.Builder) build_specific() (método sphinx.builders.Builder) build_update() (método sphinx.builders.Builder)

BuildEnvironment (classe em sphinx.environment) Builder (classe em sphinx.builders) builder (variável interna) builder-inited event built-in function enumerate() escape() hasdoc() pathto() relbar() sidebar() warning()

C

:canonical: (opção diretiva) py:attribute (diretiva) py:class (diretiva) py:data (diretiva) py:function (diretiva) py:method (diretiva) :caption: (opção diretiva) code-block (diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) :class: (opção diretiva) code-block (diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) :classmethod: (opção diretiva) py:method (diretiva) py:property (diretiva) c:alias (diretiva) :maxdepth: (opção diretiva) :noroot: (opção diretiva) c:data (papel) c:enum (diretiva) (papel) c:enumerator (diretiva) (papel) c:expr (papel) c:func (papel) c:function (diretiva) :single-line-parameter-list: (opção diretiva) c:macro (diretiva) :single-line-parameter-list: (opção diretiva) c:macro (papel) c:member (diretiva) (papel) c:namespace (diretiva) c:namespace-pop (diretiva) c:namespace-push (diretiva) c:struct (diretiva) (papel) c:texpr (papel) c:type (diretiva) (papel) c:union (diretiva) (papel) c:var (diretiva) (papel) c_extra_keywords configuration value c_id_attributes configuration value c_maximum_signature_line_length configuration value c_paren_attributes configuration value category (atributo sphinx.errors.SphinxError) centered (diretiva) changes in version ChangesBuilder (classe em sphinx.builders.changes) check_consistency() (método sphinx.domains.Domain) CheckExternalLinksBuilder (classe em sphinx.builders.linkcheck) class (variável interna) classes (variável interna) clear_doc() (método sphinx.domains.Domain) (método sphinx.environment.collectors.EnvironmentCollector) code examples code (papel) code-block (diretiva) :caption: (opção diretiva) :class: (opção diretiva) :dedent: (opção diretiva) :emphasize-lines: (opção diretiva) :force: (opção diretiva) :lineno-start: (opção diretiva) :linenos: (opção diretiva) :name: (opção diretiva) codeauthor (diretiva) command (papel) compact_paragraph (classe em sphinx.addnodes) conf module confdir (atributo sphinx.application.Sphinx) config (atributo sphinx.environment.BuildEnvironment) (atributo sphinx.parsers.Parser) Config (classe em sphinx.config) config (propriedade sphinx.transforms.SphinxTransform ) (propriedade sphinx.util.docutils.SphinxDirective ) (propriedade sphinx.util.docutils.SphinxRole ) config-inited event ConfigError configuration value add_function_parentheses add_module_names applehelp_bundle_id applehelp_bundle_name applehelp_bundle_version applehelp_codesign_flags applehelp_codesign_identity applehelp_codesign_path applehelp_dev_region applehelp_disable_external_tools applehelp_icon applehelp_index_anchors applehelp_indexer_path applehelp_kb_product applehelp_kb_url applehelp_locale applehelp_min_term_length applehelp_remote_url applehelp_stopwords applehelp_title author autoclass_content autodoc_class_signature autodoc_default_flags autodoc_default_options autodoc_docstring_signature autodoc_inherit_docstrings autodoc_member_order autodoc_mock_imports autodoc_preserve_defaults autodoc_type_aliases autodoc_typehints autodoc_typehints_description_target autodoc_typehints_format autodoc_warningiserror autosectionlabel_maxdepth autosectionlabel_prefix_document autosummary_context autosummary_filename_map autosummary_generate autosummary_generate_overwrite autosummary_ignore_module_all autosummary_imported_members autosummary_mock_imports c_extra_keywords c_id_attributes c_maximum_signature_line_length c_paren_attributes copyright coverage_c_path coverage_c_regexes coverage_ignore_c_items coverage_ignore_classes coverage_ignore_functions coverage_ignore_modules coverage_ignore_pyobjects coverage_show_missing_items coverage_skip_undoc_in_source coverage_statistics_to_report coverage_statistics_to_stdout coverage_write_headline cpp_id_attributes cpp_index_common_prefix cpp_maximum_signature_line_length cpp_paren_attributes default_role doctest_default_flags doctest_global_cleanup doctest_global_setup doctest_path doctest_show_successes doctest_test_doctest_blocks epub_author epub_basename epub_contributor epub_copyright epub_cover epub_css_files epub_description epub_exclude_files epub_fix_images epub_guide epub_identifier epub_language epub_max_image_width epub_post_files epub_pre_files epub_publisher epub_scheme epub_show_urls epub_theme epub_theme_options epub_title epub_tocdepth epub_tocdup epub_tocscope epub_uid epub_use_index epub_writing_mode exclude_patterns extensions extlinks extlinks_detect_hardcoded_links figure_language_filename gettext_additional_targets gettext_allow_fuzzy_translations gettext_auto_build gettext_compact gettext_location gettext_uuid graphviz_dot graphviz_dot_args graphviz_output_format highlight_language highlight_options html4_writer html_additional_pages html_baseurl html_codeblock_linenos_style html_compact_lists html_context html_copy_source html_css_files html_domain_indices html_experimental_html5_writer html_extra_path html_favicon html_file_suffix html_js_files html_last_updated_fmt html_link_suffix html_logo html_math_renderer html_output_encoding html_permalinks html_permalinks_icon html_scaled_image_link html_search_language html_search_options html_search_scorer html_secnumber_suffix html_short_title html_show_copyright html_show_search_summary html_show_sourcelink html_show_sphinx html_sidebars html_sourcelink_suffix html_split_index html_static_path html_style html_theme html_theme_options html_theme_path html_title html_use_index html_use_opensearch html_use_smartypants htmlhelp_basename htmlhelp_file_suffix htmlhelp_link_suffix image_converter image_converter_args imgmath_add_tooltips imgmath_dvipng imgmath_dvipng_args imgmath_dvisvgm imgmath_dvisvgm_args imgmath_embed imgmath_font_size imgmath_image_format imgmath_latex imgmath_latex_args imgmath_latex_preamble imgmath_use_preview include_patterns inheritance_alias inheritance_edge_attrs inheritance_graph_attrs inheritance_node_attrs intersphinx_cache_limit intersphinx_disabled_reftypes intersphinx_mapping intersphinx_timeout javascript_maximum_signature_line_length jsmath_path keep_warnings language latex_additional_files latex_appendices latex_docclass latex_documents latex_domain_indices latex_elements latex_engine latex_logo latex_show_pagerefs latex_show_urls latex_table_style latex_theme latex_theme_options latex_theme_path latex_toplevel_sectioning latex_use_latex_multicolumn latex_use_xindy linkcheck_allow_unauthorized linkcheck_allowed_redirects linkcheck_anchors linkcheck_anchors_ignore linkcheck_anchors_ignore_for_url linkcheck_auth linkcheck_exclude_documents linkcheck_ignore linkcheck_rate_limit_timeout linkcheck_report_timeouts_as_broken linkcheck_request_headers linkcheck_retries linkcheck_timeout linkcheck_workers linkcode_resolve locale_dirs man_make_section_directory man_pages man_show_urls manpages_url master_doc math_eqref_format math_number_all math_numfig mathjax2_config mathjax3_config mathjax_config mathjax_options mathjax_path maximum_signature_line_length modindex_common_prefix napoleon_attr_annotations napoleon_custom_sections napoleon_google_docstring napoleon_include_init_with_doc napoleon_include_private_with_doc napoleon_include_special_with_doc napoleon_numpy_docstring napoleon_preprocess_types napoleon_type_aliases napoleon_use_admonition_for_examples napoleon_use_admonition_for_notes napoleon_use_admonition_for_references napoleon_use_ivar napoleon_use_keyword napoleon_use_param napoleon_use_rtype needs_extensions needs_sphinx nitpick_ignore nitpick_ignore_regex nitpicky numfig numfig_format numfig_secnum_depth option_emphasise_placeholders primary_domain project project_copyright pygments_style python_display_short_literal_types python_maximum_signature_line_length python_use_unqualified_type_names qthelp_basename qthelp_namespace qthelp_theme qthelp_theme_options release root_doc rst_epilog rst_prolog show_authors show_warning_types singlehtml_sidebars smartquotes smartquotes_action smartquotes_excludes source_encoding source_parsers 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 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

connect() (método sphinx.application.Sphinx) (método sphinx.events.EventManager)

construtor

C

content (atributo docutils.parsers.rst.Directive) (atributo sphinx.util.docutils.SphinxRole) content_offset (atributo docutils.parsers.rst.Directive) contents table of conversion_rules (atributo sphinx.transforms.post_transforms.images.ImageConverter) convert() (método sphinx.transforms.post_transforms.images.ImageConverter) copyright configuration value copyright (variável interna) coverage_c_path configuration value coverage_c_regexes configuration value coverage_ignore_c_items configuration value coverage_ignore_classes configuration value coverage_ignore_functions configuration value coverage_ignore_modules configuration value coverage_ignore_pyobjects configuration value coverage_show_missing_items configuration value coverage_skip_undoc_in_source configuration value coverage_statistics_to_report configuration value coverage_statistics_to_stdout configuration value coverage_write_headline configuration value CoverageBuilder (classe em sphinx.ext.coverage) cpp:alias (diretiva) :maxdepth: (opção diretiva) :noroot: (opção diretiva)

cpp:any (papel) cpp:class (diretiva) (papel) cpp:concept (diretiva) (papel) cpp:enum (diretiva) (papel) cpp:enum-class (diretiva) cpp:enum-struct (diretiva) cpp:enumerator (diretiva) (papel) cpp:expr (papel) cpp:func (papel) cpp:function (diretiva) :single-line-parameter-list: (opção diretiva) cpp:member (diretiva) (papel) cpp:namespace (diretiva) cpp:namespace-pop (diretiva) cpp:namespace-push (diretiva) cpp:struct (diretiva) (papel) cpp:texpr (papel) cpp:type (diretiva) (papel) cpp:union (diretiva) cpp:var (diretiva) (papel) cpp_id_attributes configuration value cpp_index_common_prefix configuration value cpp_maximum_signature_line_length configuration value cpp_paren_attributes configuration value critical() (método sphinx.util.logging.SphinxLoggerAdapter) CustomList (C++ type) cut_lines() (no módulo sphinx.ext.autodoc)

D

:dedent: (opção diretiva) code-block (diretiva) :deprecated: (opção diretiva) py:module (diretiva) dangling_warnings (atributo sphinx.domains.Domain) data (atributo sphinx.domains.Domain) data_version (atributo sphinx.domains.Domain) debug() (método sphinx.util.logging.SphinxLoggerAdapter) default domain role default-domain (diretiva) default_priority (atributo sphinx.transforms.post_transforms.images.ImageConverter) default_role configuration value default_translator_class (atributo sphinx.builders.Builder) delete_comment() (método sphinxcontrib.websupport.storage.StorageBackend) deprecated (diretiva) desc (classe em sphinx.addnodes) desc_addname (classe em sphinx.addnodes) desc_annotation (classe em sphinx.addnodes) desc_content (classe em sphinx.addnodes) desc_inline (classe em sphinx.addnodes) desc_name (classe em sphinx.addnodes) desc_optional (classe em sphinx.addnodes) desc_parameter (classe em sphinx.addnodes) desc_parameterlist (classe em sphinx.addnodes)

desc_returns (classe em sphinx.addnodes) desc_sig_element (classe em sphinx.addnodes) desc_sig_keyword (classe em sphinx.addnodes) desc_sig_keyword_type (classe em sphinx.addnodes) desc_sig_literal_char (classe em sphinx.addnodes) desc_sig_literal_number (classe em sphinx.addnodes) desc_sig_literal_string (classe em sphinx.addnodes) desc_sig_name (classe em sphinx.addnodes) desc_sig_operator (classe em sphinx.addnodes) desc_sig_punctuation (classe em sphinx.addnodes) desc_sig_space (classe em sphinx.addnodes) desc_signature (classe em sphinx.addnodes) desc_signature_line (classe em sphinx.addnodes) desc_type (classe em sphinx.addnodes) describe (diretiva) DevhelpBuilder (classe em sphinxcontrib.devhelp) dfn (papel) digraph (diretiva) :align: (opção diretiva) :alt: (opção diretiva) :caption: (opção diretiva) :class: (opção diretiva) :layout: (opção diretiva) :name: (opção diretiva) Directive (classe em docutils.parsers.rst) directive() (método sphinx.domains.Domain) directives (atributo sphinx.domains.Domain) DirectoryHTMLBuilder (classe em sphinx.builders.dirhtml)

diretiva

diretório de configuração diretório fonte

D

disabled (atributo sphinx.util.docutils.ReferenceRole) disconnect() (método sphinx.application.Sphinx) (método sphinx.events.EventManager) discover() (método sphinx.project.Project) display_toc (variável interna) doc (papel) doc2path() (método sphinx.environment.BuildEnvironment) (método sphinx.project.Project) docname (atributo sphinx.environment.BuildEnvironment) docnames (atributo sphinx.project.Project) docstitle (variável interna) docstring doctest (diretiva) doctest_default_flags configuration value doctest_global_cleanup configuration value

doctest_global_setup configuration value doctest_path configuration value doctest_show_successes configuration value doctest_test_doctest_blocks configuration value doctree-read event doctree-resolved event doctreedir (atributo sphinx.application.Sphinx) (atributo sphinx.environment.BuildEnvironment) documentation automatic

documento mestre

documento raiz

D

docutils.parsers.rst module

docutils_version_info (variável interna) Domain (classe em sphinx.domains)

domínio

D

download (papel)

download_reference (classe em sphinx.addnodes) DummyBuilder (classe em sphinx.builders.dummy)

E

:emphasize-lines: (opção diretiva) code-block (diretiva) embedded (variável interna) emit() (método sphinx.application.Sphinx) (método sphinx.events.EventManager) emit_firstresult() (método sphinx.application.Sphinx) (método sphinx.events.EventManager) ENUM (classe em sphinx.config) enumerable_nodes (atributo sphinx.domains.Domain) enumerate() built-in function env (atributo sphinx.parsers.Parser) (propriedade sphinx.transforms.SphinxTransform ) (propriedade sphinx.util.docutils.SphinxDirective ) (propriedade sphinx.util.docutils.SphinxRole ) env-before-read-docs event env-check-consistency event env-get-outdated event env-merge-info event env-purge-doc event env-updated event env_version (atributo sphinx.util.typing.ExtensionMetadata) EnvironmentCollector (classe em sphinx.environment.collectors) envvar (diretiva) (papel) epilog (atributo sphinx.builders.Builder) Epub3Builder (classe em sphinx.builders.epub3) epub_author configuration value epub_basename configuration value epub_contributor configuration value epub_copyright configuration value epub_cover configuration value epub_css_files configuration value epub_description configuration value epub_exclude_files configuration value epub_fix_images configuration value epub_guide configuration value epub_identifier configuration value epub_language configuration value epub_max_image_width configuration value epub_post_files configuration value epub_pre_files configuration value

epub_publisher configuration value epub_scheme configuration value epub_show_urls configuration value epub_theme configuration value epub_theme_options configuration value epub_title configuration value epub_tocdepth configuration value epub_tocdup configuration value epub_tocscope configuration value epub_uid configuration value epub_use_index configuration value epub_writing_mode configuration value eq (papel) error() (método 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-merge-info env-purge-doc env-updated html-collect-pages html-page-context include-read linkcheck-process-uri missing-reference object-description-transform source-read todo-defined viewcode-find-source viewcode-follow-imported warn-missing-reference EventManager (classe em sphinx.events) events (atributo sphinx.builders.Builder) (atributo sphinx.environment.BuildEnvironment) examples code exceptions (variável interna) exclude_patterns configuration value

extensão

E

ExtensionError, [1] ExtensionMetadata (classe em sphinx.util.typing) extensions configuration value external (papel)

extlinks configuration value extlinks_detect_hardcoded_links configuration value extract_context() (método sphinxcontrib.websupport.search.BaseSearch)

F

:final: (opção diretiva) py:class (diretiva) py:exception (diretiva) py:method (diretiva) :force: (opção diretiva) code-block (diretiva) highlight (diretiva) favicon_url (variável interna) feed() (método sphinxcontrib.websupport.search.BaseSearch) figure_language_filename configuration value file (papel) file_suffix (variável interna) final_argument_whitespace (atributo docutils.parsers.rst.Directive) (atributo sphinx.directives.ObjectDescription) finish() (método sphinx.builders.Builder) finish_indexing() (método sphinxcontrib.websupport.search.BaseSearch) format (atributo sphinx.builders.Builder) (atributo sphinx.builders.changes.ChangesBuilder) (atributo sphinx.builders.dirhtml.DirectoryHTMLBuilder) (atributo sphinx.builders.epub3.Epub3Builder) (atributo sphinx.builders.gettext.MessageCatalogBuilder) (atributo sphinx.builders.html.StandaloneHTMLBuilder) (atributo sphinx.builders.latex.LaTeXBuilder) (atributo sphinx.builders.linkcheck.CheckExternalLinksBuilder) (atributo sphinx.builders.manpage.ManualPageBuilder) (atributo sphinx.builders.singlehtml.SingleFileHTMLBuilder) (atributo sphinx.builders.texinfo.TexinfoBuilder) (atributo sphinx.builders.text.TextBuilder) (atributo sphinx.builders.xml.PseudoXMLBuilder) (atributo sphinx.builders.xml.XMLBuilder) (atributo sphinxcontrib.applehelp.AppleHelpBuilder) (atributo sphinxcontrib.devhelp.DevhelpBuilder) (atributo sphinxcontrib.htmlhelp.HTMLHelpBuilder) (atributo sphinxcontrib.qthelp.QtHelpBuilder) (atributo sphinxcontrib.serializinghtml.JSONHTMLBuilder) (atributo sphinxcontrib.serializinghtml.PickleHTMLBuilder)

found_docs (atributo sphinx.environment.BuildEnvironment) fullname (variável interna) functions (variável interna)

G

generate() (método sphinx.domains.Index) get_data() (método sphinxcontrib.websupport.storage.StorageBackend) (método sphinxcontrib.websupport.WebSupport) get_document() (método sphinxcontrib.websupport.WebSupport) get_enumerable_node_type() (método sphinx.domains.Domain) get_full_qualified_name() (método sphinx.domains.Domain) get_location() (método sphinx.util.docutils.SphinxDirective) (método sphinx.util.docutils.SphinxRole) get_objects() (método sphinx.domains.Domain) get_outdated_docs() (método sphinx.builders.Builder) (método sphinx.environment.collectors.EnvironmentCollector) get_relative_uri() (método sphinx.builders.Builder) get_search_results() (método sphinxcontrib.websupport.WebSupport) get_signatures() (método sphinx.directives.ObjectDescription) get_source_info() (método sphinx.util.docutils.SphinxDirective) get_target_uri() (método sphinx.builders.Builder) get_translation() (no módulo sphinx.locale) get_type_name() (método sphinx.domains.Domain) get_updated_docs() (método sphinx.environment.collectors.EnvironmentCollector) getLogger() (no módulo sphinx.util.logging) gettext_additional_targets configuration value gettext_allow_fuzzy_translations configuration value gettext_auto_build configuration value gettext_compact configuration value gettext_location configuration value

gettext_uuid configuration value global substitutions, [1], [2] globalcontext_filename (atributo sphinxcontrib.serializinghtml.SerializingHTMLBuilder) glossary (classe em sphinx.addnodes) (diretiva) graph (diretiva) :align: (opção diretiva) :alt: (opção diretiva) :caption: (opção diretiva) :class: (opção diretiva) :layout: (opção diretiva) :name: (opção diretiva) graphviz (diretiva) :align: (opção diretiva) :alt: (opção diretiva) :caption: (opção diretiva) :class: (opção diretiva) :layout: (opção diretiva) :name: (opção diretiva) graphviz_dot configuration value graphviz_dot_args configuration value graphviz_output_format configuration value guilabel (papel)

H

handle_query() (método sphinxcontrib.websupport.search.BaseSearch) handle_signature() (método sphinx.directives.ObjectDescription) has_content (atributo docutils.parsers.rst.Directive) (atributo sphinx.directives.ObjectDescription) has_explicit_title (atributo sphinx.util.docutils.ReferenceRole) has_source (variável interna) hasdoc() built-in function highlight (diretiva) :force: (opção diretiva) :linenothreshold: (opção diretiva) highlight_language configuration value highlight_options configuration value highlightlang (classe em sphinx.addnodes) hlist (diretiva) html-collect-pages event html-page-context event html4_writer configuration value html_additional_pages configuration value html_baseurl configuration value html_codeblock_linenos_style configuration value html_compact_lists configuration value html_context configuration value html_copy_source configuration value html_css_files configuration value html_domain_indices configuration value html_experimental_html5_writer configuration value html_extra_path configuration value html_favicon configuration value html_file_suffix configuration value html_js_files configuration value html_last_updated_fmt configuration value html_link_suffix configuration value html_logo configuration value html_math_renderer configuration value

html_output_encoding configuration value html_permalinks configuration value html_permalinks_icon configuration value html_scaled_image_link configuration value html_search_language configuration value html_search_options configuration value html_search_scorer configuration value html_secnumber_suffix configuration value html_short_title configuration value html_show_copyright configuration value html_show_search_summary configuration value html_show_sourcelink configuration value html_show_sphinx configuration value html_sidebars configuration value html_sourcelink_suffix configuration value html_split_index configuration value html_static_path configuration value html_style configuration value html_theme configuration value html_theme_options configuration value html_theme_path configuration value html_title configuration value html_use_index configuration value html_use_opensearch configuration value html_use_smartypants configuration value htmlhelp_basename configuration value htmlhelp_file_suffix configuration value htmlhelp_link_suffix configuration value HTMLHelpBuilder (classe em sphinxcontrib.htmlhelp)

I

ifconfig (diretiva) image_converter configuration value image_converter_args configuration value ImageConverter (classe em sphinx.transforms.post_transforms.images) imgmath_add_tooltips configuration value imgmath_dvipng configuration value imgmath_dvipng_args configuration value imgmath_dvisvgm configuration value imgmath_dvisvgm_args configuration value imgmath_embed configuration value imgmath_font_size configuration value imgmath_image_format configuration value imgmath_latex configuration value imgmath_latex_args configuration value imgmath_latex_preamble configuration value imgmath_use_preview configuration value implementation (atributo sphinxcontrib.serializinghtml.SerializingHTMLBuilder) in version changes include-read event include_patterns configuration value

index (classe em sphinx.addnodes) Index (classe em sphinx.domains) index (diretiva) :name: (opção diretiva) index (papel) indices (atributo sphinx.domains.Domain) info() (método sphinx.util.logging.SphinxLoggerAdapter) inheritance-diagram (diretiva) inheritance_alias configuration value inheritance_edge_attrs configuration value inheritance_graph_attrs configuration value inheritance_node_attrs configuration value inherited_members (variável interna) init() (método sphinx.application.TemplateBridge) (método sphinx.builders.Builder) (no módulo sphinx.locale) init_console() (no módulo sphinx.locale) init_indexing() (método sphinxcontrib.websupport.search.BaseSearch) initial_data (atributo sphinx.domains.Domain) inliner (atributo sphinx.util.docutils.SphinxRole) intersphinx_cache_limit configuration value intersphinx_disabled_reftypes configuration value intersphinx_mapping configuration value intersphinx_timeout configuration value is_available() (método sphinx.transforms.post_transforms.images.ImageConverter) is_parallel_allowed() (método sphinx.application.Sphinx) is_supported() (método sphinx.transforms.post_transforms.SphinxPostTransform)

J

javascript_maximum_signature_line_length configuration value js:attr (papel) js:attribute (diretiva) js:class (diretiva) :single-line-parameter-list: (opção diretiva) js:class (papel) js:data (diretiva) (papel) js:func (papel)

js:function (diretiva) :single-line-parameter-list: (opção diretiva) js:meth (papel) js:method (diretiva) :single-line-parameter-list: (opção diretiva) js:mod (papel) js:module (diretiva) jsmath_path configuration value JSONHTMLBuilder (classe em sphinxcontrib.serializinghtml)

K

kbd (papel) keep_warnings configuration value

keyword (papel)

L

:layout: (opção diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) :lineno-start: (opção diretiva) code-block (diretiva) :linenos: (opção diretiva) code-block (diretiva) :linenothreshold: (opção diretiva) highlight (diretiva) label (atributo sphinx.domains.Domain) language configuration value language (variável interna) last_updated (variável interna) latex module latex_additional_files configuration value latex_appendices configuration value latex_docclass configuration value latex_documents configuration value latex_domain_indices configuration value latex_elements configuration value latex_engine configuration value latex_logo configuration value latex_show_pagerefs configuration value latex_show_urls configuration value latex_table_style configuration value latex_theme configuration value latex_theme_options configuration value latex_theme_path configuration value latex_toplevel_sectioning configuration value

latex_use_latex_multicolumn configuration value latex_use_xindy configuration value LaTeXBuilder (classe em sphinx.builders.latex) lineno (atributo docutils.parsers.rst.Directive) (atributo sphinx.util.docutils.SphinxRole) linkcheck-process-uri event linkcheck_allow_unauthorized configuration value linkcheck_allowed_redirects configuration value linkcheck_anchors configuration value linkcheck_anchors_ignore configuration value linkcheck_anchors_ignore_for_url configuration value linkcheck_auth configuration value linkcheck_exclude_documents configuration value linkcheck_ignore configuration value linkcheck_rate_limit_timeout configuration value linkcheck_report_timeouts_as_broken configuration value linkcheck_request_headers configuration value linkcheck_retries configuration value linkcheck_timeout configuration value linkcheck_workers configuration value linkcode_resolve configuration value linking automatic literal_emphasis (classe em sphinx.addnodes) literalinclude (diretiva) locale_dirs configuration value log() (método sphinx.util.logging.SphinxLoggerAdapter) logo_url (variável interna)

M

:maxdepth: (opção diretiva) c:alias (diretiva) cpp:alias (diretiva) :members: (opção diretiva) automodule (diretiva) mailheader (papel) makevar (papel) man_make_section_directory configuration value man_pages configuration value man_show_urls configuration value manpage (papel) manpages_url configuration value ManualPageBuilder (classe em sphinx.builders.manpage) master_doc configuration value master_doc (variável interna) math (diretiva) (papel) math:numref (papel) math_eqref_format configuration value math_number_all configuration value math_numfig configuration value mathjax2_config configuration value mathjax3_config configuration value mathjax_config configuration value mathjax_options configuration value mathjax_path configuration value maximum_signature_line_length configuration value members (variável interna) menuselection (papel) merge_domaindata() (método sphinx.domains.Domain) merge_other() (método sphinx.environment.collectors.EnvironmentCollector) MessageCatalogBuilder (classe em sphinx.builders.gettext) meta (variável interna) metadata (atributo sphinx.environment.BuildEnvironment) metatags (variável interna) methods (variável interna) mimetype (papel) missing-reference event modindex_common_prefix configuration value

module conf docutils.parsers.rst latex sphinx.addnodes sphinx.application sphinx.builders sphinx.builders.changes sphinx.builders.dirhtml sphinx.builders.dummy sphinx.builders.epub3 sphinx.builders.gettext sphinx.builders.html sphinx.builders.latex sphinx.builders.linkcheck sphinx.builders.manpage sphinx.builders.singlehtml sphinx.builders.texinfo sphinx.builders.text sphinx.builders.xml sphinx.directives sphinx.domains sphinx.domains.python sphinx.environment sphinx.environment.collectors sphinx.errors sphinx.ext.autodoc sphinx.ext.autosectionlabel sphinx.ext.autosummary sphinx.ext.coverage sphinx.ext.doctest sphinx.ext.duration sphinx.ext.extlinks sphinx.ext.githubpages sphinx.ext.graphviz sphinx.ext.ifconfig sphinx.ext.imgconverter sphinx.ext.imgmath sphinx.ext.inheritance_diagram sphinx.ext.intersphinx sphinx.ext.jsmath sphinx.ext.linkcode sphinx.ext.mathbase sphinx.ext.mathjax sphinx.ext.napoleon sphinx.ext.todo sphinx.ext.viewcode sphinx.parsers sphinxcontrib.applehelp sphinxcontrib.devhelp sphinxcontrib.htmlhelp sphinxcontrib.qthelp module (variável interna) modules (atributo sphinx.domains.python.PythonDomain) (variável interna)

N

:name: (opção diretiva) code-block (diretiva) digraph (diretiva) graph (diretiva) graphviz (diretiva) index (diretiva) :noroot: (opção diretiva) c:alias (diretiva) cpp:alias (diretiva) name (atributo docutils.parsers.rst.Directive) (atributo sphinx.builders.Builder) (atributo sphinx.builders.changes.ChangesBuilder) (atributo sphinx.builders.dirhtml.DirectoryHTMLBuilder) (atributo sphinx.builders.dummy.DummyBuilder) (atributo sphinx.builders.epub3.Epub3Builder) (atributo sphinx.builders.gettext.MessageCatalogBuilder) (atributo sphinx.builders.html.StandaloneHTMLBuilder) (atributo sphinx.builders.latex.LaTeXBuilder) (atributo sphinx.builders.linkcheck.CheckExternalLinksBuilder) (atributo sphinx.builders.manpage.ManualPageBuilder) (atributo sphinx.builders.singlehtml.SingleFileHTMLBuilder) (atributo sphinx.builders.texinfo.TexinfoBuilder) (atributo sphinx.builders.text.TextBuilder) (atributo sphinx.builders.xml.PseudoXMLBuilder) (atributo sphinx.builders.xml.XMLBuilder) (atributo sphinx.domains.Domain) (atributo sphinx.util.docutils.SphinxRole) (atributo sphinxcontrib.applehelp.AppleHelpBuilder) (atributo sphinxcontrib.devhelp.DevhelpBuilder) (atributo sphinxcontrib.htmlhelp.HTMLHelpBuilder) (atributo sphinxcontrib.qthelp.QtHelpBuilder) (atributo sphinxcontrib.serializinghtml.JSONHTMLBuilder) (atributo sphinxcontrib.serializinghtml.PickleHTMLBuilder) (variável interna) napoleon_attr_annotations configuration value napoleon_custom_sections configuration value napoleon_google_docstring configuration value

napoleon_include_init_with_doc configuration value napoleon_include_private_with_doc configuration value napoleon_include_special_with_doc configuration value napoleon_numpy_docstring configuration value napoleon_preprocess_types configuration value napoleon_type_aliases configuration value napoleon_use_admonition_for_examples configuration value napoleon_use_admonition_for_notes configuration value napoleon_use_admonition_for_references configuration value napoleon_use_ivar configuration value napoleon_use_keyword configuration value napoleon_use_param configuration value napoleon_use_rtype configuration value needs_extensions configuration value needs_sphinx configuration value new_serialno() (método sphinx.environment.BuildEnvironment) newest_template_mtime() (método sphinx.application.TemplateBridge) newsgroup (papel) next (variável interna) nitpick_ignore configuration value nitpick_ignore_regex configuration value nitpicky configuration value

nome do documento

N

note (diretiva) note_dependency() (método sphinx.environment.BuildEnvironment) note_module() (método sphinx.domains.python.PythonDomain) note_object() (método sphinx.domains.python.PythonDomain) note_reread() (método sphinx.environment.BuildEnvironment)

numfig configuration value numfig_format configuration value numfig_secnum_depth configuration value numref (papel)

O

object (diretiva) object-description-transform event

object_types (atributo sphinx.domains.Domain) ObjectDescription (classe em sphinx.directives) objects (atributo sphinx.domains.python.PythonDomain)

objeto

O

objname (variável interna) ObjType (classe em sphinx.domains) objtype (variável interna) only (classe em sphinx.addnodes) (diretiva) option (diretiva) (papel) option_emphasise_placeholders configuration value

option_spec (atributo docutils.parsers.rst.Directive) (atributo sphinx.directives.ObjectDescription) optional_arguments (atributo docutils.parsers.rst.Directive) (atributo sphinx.directives.ObjectDescription) options (atributo docutils.parsers.rst.Directive) (atributo sphinx.util.docutils.SphinxRole) out_suffix (atributo sphinxcontrib.serializinghtml.SerializingHTMLBuilder) outdir (atributo sphinx.application.Sphinx)

P

:platform: (opção diretiva) py:module (diretiva) :private-members: (opção diretiva) automodule (diretiva)

page_source_suffix (variável interna) pagename (variável interna)

papel

P

parallel_read_safe (atributo sphinx.util.typing.ExtensionMetadata) parallel_write_safe (atributo sphinx.util.typing.ExtensionMetadata) parents (variável interna) Parser (classe em sphinx.parsers) path2doc() (método sphinx.project.Project) pathto() built-in function pending_logging() (no módulo sphinx.util.logging) pending_warnings() (no módulo sphinx.util.logging) pending_xref (classe em sphinx.addnodes) pending_xref_condition (classe em sphinx.addnodes) pep (papel) PickleHTMLBuilder (classe em sphinxcontrib.serializinghtml) post_build() (método sphinxcontrib.websupport.storage.StorageBackend) pre_build() (método sphinxcontrib.websupport.storage.StorageBackend) prefixed_warnings() (no módulo sphinx.util.logging) prepare_writing() (método sphinx.builders.Builder) prev (variável interna) primary domain primary_domain configuration value process_doc() (método sphinx.domains.Domain) (método sphinx.environment.collectors.EnvironmentCollector) process_field_xref() (método sphinx.domains.Domain) process_vote() (método sphinxcontrib.websupport.storage.StorageBackend) (método sphinxcontrib.websupport.WebSupport) production (classe em sphinx.addnodes) productionlist (classe em sphinx.addnodes) (diretiva) program (diretiva) (papel) project configuration value project (atributo sphinx.application.Sphinx) (atributo sphinx.environment.BuildEnvironment) Project (classe em sphinx.project) project (variável interna) project_copyright configuration value Propostas Estendidas Python PEP 257#what-is-a-docstring PEP 287 PEP 420 PEP 440 PEP 440#version-specifiers PEP 484, [1], [2] PEP 526, [1] PEP 563 PEP 585 PEP 604 PEP 695, [1], [2], [3] PEP 696 PEP 8 PseudoXMLBuilder (classe em sphinx.builders.xml) py:attr (papel) py:attribute (diretiva) :canonical: (opção diretiva) :type: (opção diretiva) :value: (opção diretiva)

py:class (diretiva) :canonical: (opção diretiva) :final: (opção diretiva) :single-line-parameter-list: (opção diretiva) :single-line-type-parameter-list: (opção diretiva) py:class (papel) py:classmethod (diretiva) py:const (papel) py:currentmodule (diretiva) py:data (diretiva) :canonical: (opção diretiva) :type: (opção diretiva) :value: (opção diretiva) py:data (papel) py:decorator (diretiva) :single-line-parameter-list: (opção diretiva) :single-line-type-parameter-list: (opção diretiva) py:decoratormethod (diretiva) py:exc (papel) py:exception (diretiva) :final: (opção diretiva) :single-line-parameter-list: (opção diretiva) :single-line-type-parameter-list: (opção diretiva) py:func (papel) py:function (diretiva) :async: (opção diretiva) :canonical: (opção diretiva) :single-line-parameter-list: (opção diretiva) :single-line-type-parameter-list: (opção diretiva) py:meth (papel) py:method (diretiva) :abstractmethod: (opção diretiva) :async: (opção diretiva) :canonical: (opção diretiva) :classmethod: (opção diretiva) :final: (opção diretiva) :single-line-parameter-list: (opção diretiva) :single-line-type-parameter-list: (opção diretiva) :staticmethod: (opção diretiva) py:mod (papel) py:module (diretiva) :deprecated: (opção diretiva) :platform: (opção diretiva) :synopsis: (opção diretiva) py:obj (papel) py:property (diretiva) :abstractmethod: (opção diretiva) :classmethod: (opção diretiva) :type: (opção diretiva) py:staticmethod (diretiva) pygments_style configuration value python:PYTHONWARNINGS python_display_short_literal_types configuration value python_maximum_signature_line_length configuration value python_use_unqualified_type_names configuration value PythonDomain (classe em sphinx.domains.python) PyType_GenericAlloc (C function)

Q

qthelp_basename configuration value qthelp_namespace configuration value qthelp_theme configuration value

qthelp_theme_options configuration value QtHelpBuilder (classe em sphinxcontrib.qthelp) query() (método sphinxcontrib.websupport.search.BaseSearch)

R

rawtext (atributo sphinx.util.docutils.SphinxRole) ref (papel) ReferenceRole (classe em sphinx.util.docutils) regexp (papel) relbar() built-in function reldelim1 (variável interna) reldelim2 (variável interna) release configuration value release (variável interna) relfn2path() (método sphinx.environment.BuildEnvironment) rellinks (variável interna) RemoveInSphinxXXXWarning render() (método sphinx.application.TemplateBridge) render_string() (método sphinx.application.TemplateBridge) require_sphinx() (método estático sphinx.application.Sphinx) required_arguments (atributo docutils.parsers.rst.Directive) (atributo sphinx.directives.ObjectDescription) resolve_any_xref() (método sphinx.domains.Domain) resolve_xref() (método sphinx.domains.Domain) restore() (método sphinx.project.Project) reStructuredText

RFC RFC 2324 RFC 3986#section-4.4 RFC 8081 rfc (papel) role() (método sphinx.domains.Domain) roles (atributo sphinx.domains.Domain) root_doc configuration value root_doc (variável interna) rst:dir (papel) rst:directive (diretiva) rst:directive:option (diretiva) :type: (opção diretiva) rst:role (diretiva) (papel) rst_epilog configuration value rst_prolog configuration value rubric (diretiva) run() (método docutils.parsers.rst.Directive) (método sphinx.directives.ObjectDescription) (método sphinx.transforms.post_transforms.SphinxPostTransform)

S

:single-line-parameter-list: (opção diretiva) c:function (diretiva) c:macro (diretiva) cpp:function (diretiva) js:class (diretiva) js:function (diretiva) js:method (diretiva) py:class (diretiva) py:decorator (diretiva) py:exception (diretiva) py:function (diretiva) py:method (diretiva) :single-line-type-parameter-list: (opção diretiva) py:class (diretiva) py:decorator (diretiva) py:exception (diretiva) py:function (diretiva) py:method (diretiva) :special-members: (opção diretiva) automodule (diretiva) :staticmethod: (opção diretiva) py:method (diretiva) :synopsis: (opção diretiva) py:module (diretiva) samp (papel) script_files (variável interna) searchindex_filename (atributo sphinxcontrib.serializinghtml.SerializingHTMLBuilder) sectionauthor (diretiva) seealso (classe em sphinx.addnodes) (diretiva) SerializingHTMLBuilder (classe em sphinxcontrib.serializinghtml) set_application() (método sphinx.parsers.Parser) set_source_info() (método sphinx.util.docutils.SphinxDirective) set_translator() (método sphinx.application.Sphinx) setup() (método sphinx.domains.Domain) setup_extension() (método sphinx.application.Sphinx) shorttitle (variável interna) show_authors configuration value show_source (variável interna) show_warning_types configuration value sidebar() built-in function SIG_ELEMENTS (no módulo sphinx.addnodes) SingleFileHTMLBuilder (classe em sphinx.builders.singlehtml) singlehtml_sidebars configuration value smartquotes configuration value smartquotes_action configuration value smartquotes_excludes configuration value snippets testing source-read event source_encoding configuration value source_parsers configuration value source_suffix configuration value source_suffix (atributo sphinx.project.Project) sourcecode (diretiva) sourcename (variável interna) Sphinx (classe em sphinx.application) sphinx-apidoc opção de linha de comando --dry-run --follow-links --force --full --implicit-namespaces --module-first --no-headings --no-toc --private --separate --templatedir --tocfile -a -A -d -e -E -f -F -H -l -M -n -o -P -q -R -s -T -t -V sphinx-autogen opção de linha de comando --imported-members --respect-module-all --suffix --templates -a -i -o -s -t sphinx-build opção de linha de comando --builder --color --config-dir --define --doctree-dir --fail-on-warning --fresh-env --help --html-define --isolated --jobs --keep-going --nitpicky --no-color --pdb --quiet --show-traceback --silent --tag --verbose --version --warning-file --write-all -a -A -b -c -C -d -D -E -h -j -M -n -N -P -q -Q -t -T -v -w -W sphinx-quickstart opção de linha de comando --author --batchfile --dot --ext-autodoc --ext-coverage --ext-doctest --ext-githubpages --ext-ifconfig --ext-imgmath --ext-intersphinx --ext-mathjax --ext-todo --ext-viewcode --extensions --help --language --makefile --master --no-batchfile --no-makefile --no-sep --no-use-make-mode --project --quiet --release --sep --suffix --templatedir --use-make-mode --version -a -d -h -l -p -q -r -t -v

sphinx.addnodes module sphinx.application module sphinx.builders module sphinx.builders.changes module sphinx.builders.dirhtml module sphinx.builders.dummy module sphinx.builders.epub3 module sphinx.builders.gettext module sphinx.builders.html module sphinx.builders.latex module sphinx.builders.linkcheck module sphinx.builders.manpage module sphinx.builders.singlehtml module sphinx.builders.texinfo module sphinx.builders.text module sphinx.builders.xml module sphinx.directives module sphinx.domains module sphinx.domains.python module sphinx.environment module sphinx.environment.collectors module sphinx.errors module sphinx.ext.autodoc module sphinx.ext.autosectionlabel module sphinx.ext.autosummary module sphinx.ext.coverage module sphinx.ext.doctest module sphinx.ext.duration module sphinx.ext.extlinks module sphinx.ext.githubpages module sphinx.ext.graphviz module sphinx.ext.ifconfig module sphinx.ext.imgconverter module sphinx.ext.imgmath module sphinx.ext.inheritance_diagram module sphinx.ext.intersphinx module sphinx.ext.jsmath module sphinx.ext.linkcode module sphinx.ext.mathbase module sphinx.ext.mathjax module sphinx.ext.napoleon module sphinx.ext.todo module sphinx.ext.viewcode module sphinx.parsers module sphinx_version (variável interna) sphinx_version_tuple (variável interna) sphinxcontrib.applehelp module sphinxcontrib.devhelp module sphinxcontrib.htmlhelp module sphinxcontrib.qthelp module SphinxDirective (classe em sphinx.util.docutils) SphinxError SphinxLoggerAdapter (classe em sphinx.util.logging) SphinxPostTransform (classe em sphinx.transforms.post_transforms) SphinxRole (classe em sphinx.util.docutils) SphinxTransform (classe em sphinx.transforms) srcdir (atributo sphinx.application.Sphinx) (atributo sphinx.environment.BuildEnvironment) (atributo sphinx.project.Project) StandaloneHTMLBuilder (classe em sphinx.builders.html) start_of_file (classe em sphinx.addnodes) state (atributo docutils.parsers.rst.Directive) state_machine (atributo docutils.parsers.rst.Directive) StorageBackend (classe em sphinxcontrib.websupport.storage) strip_signature_backslash configuration value styles (variável interna) substitutions global, [1], [2] supported_data_uri_images (atributo sphinx.builders.Builder) supported_image_types (atributo sphinx.builders.Builder) (atributo sphinx.builders.changes.ChangesBuilder) (atributo sphinx.builders.dirhtml.DirectoryHTMLBuilder) (atributo sphinx.builders.dummy.DummyBuilder) (atributo sphinx.builders.epub3.Epub3Builder) (atributo sphinx.builders.gettext.MessageCatalogBuilder) (atributo sphinx.builders.html.StandaloneHTMLBuilder) (atributo sphinx.builders.latex.LaTeXBuilder) (atributo sphinx.builders.linkcheck.CheckExternalLinksBuilder) (atributo sphinx.builders.manpage.ManualPageBuilder) (atributo sphinx.builders.singlehtml.SingleFileHTMLBuilder) (atributo sphinx.builders.texinfo.TexinfoBuilder) (atributo sphinx.builders.text.TextBuilder) (atributo sphinx.builders.xml.PseudoXMLBuilder) (atributo sphinx.builders.xml.XMLBuilder) (atributo sphinxcontrib.applehelp.AppleHelpBuilder) (atributo sphinxcontrib.devhelp.DevhelpBuilder) (atributo sphinxcontrib.htmlhelp.HTMLHelpBuilder) (atributo sphinxcontrib.qthelp.QtHelpBuilder) (atributo sphinxcontrib.serializinghtml.JSONHTMLBuilder) (atributo sphinxcontrib.serializinghtml.PickleHTMLBuilder) supported_remote_images (atributo sphinx.builders.Builder) suppress_warnings configuration value

T

:type: (opção diretiva) py:attribute (diretiva) py:data (diretiva) py:property (diretiva) rst:directive:option (diretiva) table of contents tabularcolumns (diretiva) target (atributo sphinx.util.docutils.ReferenceRole) template_bridge configuration value TemplateBridge (classe em sphinx.application) templates_path configuration value term (papel) testcleanup (diretiva) testcode (diretiva) testing automatic snippets testoutput (diretiva) testsetup (diretiva) texinfo_appendices configuration value texinfo_cross_references configuration value texinfo_documents configuration value texinfo_domain_indices configuration value texinfo_elements configuration value texinfo_no_detailmenu configuration value texinfo_show_urls configuration value TexinfoBuilder (classe em sphinx.builders.texinfo) text (atributo sphinx.util.docutils.SphinxRole) text_add_secnumbers configuration value text_newlines configuration value

text_secnumber_suffix configuration value text_sectionchars configuration value TextBuilder (classe em sphinx.builders.text) ThemeError title (atributo sphinx.util.docutils.ReferenceRole) (variável interna) titles (atributo sphinx.environment.BuildEnvironment) tls_cacerts configuration value tls_verify configuration value toc (variável interna) toc_object_entries configuration value toc_object_entries_show_parents configuration value toctree (classe em sphinx.addnodes) (diretiva) (variável interna) today configuration value today_fmt configuration value todo (diretiva) todo-defined event todo_emit_warnings configuration value todo_include_todos configuration value todo_link_only configuration value todolist (diretiva) token (papel) transform_content() (método sphinx.directives.ObjectDescription) translation_progress_classes configuration value trim_doctest_flags configuration value trim_footnote_reference_space configuration value

U

:undoc-members: (opção diretiva) automodule (diretiva) underline (variável interna)

update_username() (método sphinxcontrib.websupport.storage.StorageBackend) use_opensearch (variável interna) user_agent configuration value

V

:value: (opção diretiva) py:attribute (diretiva) py:data (diretiva) variável de ambiente python:PYTHONWARNINGS SPHINX_APIDOC_OPTIONS verbose() (método sphinx.util.logging.SphinxLoggerAdapter) version configuration value version (atributo sphinx.util.typing.ExtensionMetadata) (variável interna) version_info (no módulo sphinx) versionadded (diretiva)

versionchanged (diretiva) versionmodified (classe em sphinx.addnodes) versionremoved (diretiva) VersionRequirementError viewcode-find-source event viewcode-follow-imported event viewcode_enable_epub configuration value viewcode_follow_imported_members configuration value viewcode_line_numbers configuration value

W

warn-missing-reference event warning (diretiva)

warning() built-in function warning() (método sphinx.util.logging.SphinxLoggerAdapter) WebSupport (classe em sphinxcontrib.websupport) write_doc() (método sphinx.builders.Builder)

X

xml_pretty configuration value

XMLBuilder (classe em sphinx.builders.xml)