auto_intersphinx#
Sphinx extension to automatically link package documentation from their names.
This package contains a Sphinx plugin that can fill intersphinx mappings based on package names. It simplifies the use of that plugin by removing the need of knowing URLs for various API catologs you may want to cross-reference.
Functions
|
Transforms a multiline docstring into a single line of text. |
|
Main extension method. |
|
Re-wrap a multiline docstring into a 80-character format. |
|
Sphinx extension configuration entry-point. |
- auto_intersphinx.oneliner(s)[source]#
Transforms a multiline docstring into a single line of text.
This method converts the multi-line string into a single line, while also dedenting the text.
- auto_intersphinx.rewrap(s)[source]#
Re-wrap a multiline docstring into a 80-character format.
This method first converts the multi-line string into a single line. It then wraps the single line into 80-characters width.
- auto_intersphinx.populate_intersphinx_mapping(app, config)[source]#
Main extension method.
This function is called by Sphinx once it is
setup()
. It executes the lookup procedure for all packages listed on the configuration parameterauto_intersphinx_packages
. If a catalog name is provided atauto_intersphinx_catalog
, and package information is not found on the catalogs, but discovered elsewhere (environment, readthedocs.org, or pypi.org), then it is saved on that file, so that the next lookup is faster.It follows the following search protocol for each package (first match found stops the search procedure):
User catalog (if available)
Built-in catalog distributed with the package
The current Python environment