seed_intersphinx_mapping.​extension

Sphinx-specific functionality.

Functions:

setup(​app)

Setup seed_intersphinx_mapping.

sphinx_seed_intersphinx_mapping(​app, config)

Updates the intersphinx_mapping dictionary in the sphinx configuration.
setup(app)[source]

Setup seed_intersphinx_mapping.

Parameters

app (Sphinx)

Return type

Dict[str, Any]

sphinx_seed_intersphinx_mapping(app, config)[source]

Updates the intersphinx_mapping dictionary in the sphinx configuration. to include the documentation for the project’s requirements.

pkg_requirements_source may be one of:

  • A list of directories (relative to repository_root) in which to search for requirements.txt files. Any files found will be used to compile the list of requirements.

  • The string 'requirements'. The list of requirements will be determined from the requirements.txt file in the directory given by the repository_root option.

  • The string 'pyproject' (or 'pyproject.toml'). The list will be parsed from the [project.dependencies] table of the pyproject.toml file in the repository_root.

    See also

    PEP 621 – Storing project metadata in pyproject.toml

  • The string 'flit'. The list will be parsed from the [tool.flit.metadata.requires] table of the pyproject.toml file in the repository_root.

Parameters