Domain

Python

foo.spam(eggs)

My spam

autofunction

romnn_sphinx_press_theme.google_docstring_example(param1: int, param2: str) → bool[source]

Example function with types documented in the docstring.

PEP 484 type annotations are supported. If attribute, parameter, and return types are annotated according to PEP 484, they do not need to be included in the docstring:

Parameters

  • param1 – The first parameter.

  • param2 – The second parameter.

Returns

The return value. True for success, False otherwise.

Return type

bool

romnn_sphinx_press_theme.add_toctree_data(app, pagename, templatename, context, doctree)[source]

Create toctree_data, used to build sidebar navigation

Parameters

  • pagename (str) – The name of the page

  • templatename (str) – The name of the templatename

  • context (dict) – The context

  • doctree (docutils.nodes.document) – A doctree

Add to toctree_data to context that will be available on templates. Although data is “global”, it is called once per page because current page is “highlighted”, and some part of TOC might be collapsed.

Returns

None

autoclass

class sphinx.environment.collectors.EnvironmentCollector[source]

An EnvironmentCollector is a specific data collector from each document.

It gathers data and stores BuildEnvironment as a database. Examples of specific data would be images, download files, section titles, metadatas, index entries and toctrees, etc.

clear_doc(app: Sphinx, env: sphinx.environment.BuildEnvironment, docname: str) → None[source]

Remove specified data of a document.

This method is called on the removal of the document.

get_outdated_docs(app: Sphinx, env: sphinx.environment.BuildEnvironment, added: Set[str], changed: Set[str], removed: Set[str]) → List[str][source]

Return a list of docnames to re-read.

This methods is called before reading the documents.

get_updated_docs(app: Sphinx, env: sphinx.environment.BuildEnvironment) → List[str][source]

Return a list of docnames to re-read.

This methods is called after reading the whole of documents (experimental).

merge_other(app: Sphinx, env: sphinx.environment.BuildEnvironment, docnames: Set[str], other: sphinx.environment.BuildEnvironment) → None[source]

Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.

process_doc(app: Sphinx, doctree: docutils.nodes.document) → None[source]

Process a document and gather specific data from it.

This method is called after the document is read.