seed_intersphinx_mapping.extension
¶
Sphinx-specific functionality.
Functions:
|
Setup |
|
Updates the |
-
setup
(app)[source]¶ Setup
seed_intersphinx_mapping
.
-
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 forrequirements.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 therequirements.txt
file in the directory given by therepository_root
option.The string
'pyproject'
(or'pyproject.toml'
). The list will be parsed from the[project.dependencies]
table of thepyproject.toml
file in therepository_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 thepyproject.toml
file in therepository_root
.