Welcome to jaraco.packaging documentation!#

This module is a Sphinx plugin. Add jaraco.packaging.sphinx to conf.py, and the setup hook does the rest.

>>> 'setup' in globals()
True
class jaraco.packaging.sphinx.SidebarLinksDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)#

Bases: SphinxDirective

Directive which adds a toctree to the sidebar containing links to the project home and PyPI repo.

has_content: bool = True#

May the directive have content?

option_spec = {'caption': <function unchanged_required>, 'home': <function flag>, 'pypi': <function flag>}#

Mapping of option names to validator functions.

run()#

Create the installation node.

jaraco.packaging.sphinx.add_package_url(app, pagename, templatename, context, doctree)#
jaraco.packaging.sphinx.configure_substitutions(app)#
jaraco.packaging.sphinx.load_config_from_setup(app)#

Replace values in app.config from package metadata

jaraco.packaging.sphinx.setup(app)#

Indices and tables#