PSphinxTheme.ext.relbar_links¶

Overview¶

adds link entries to relbar

This Sphinx extension automatically inserts entries into the navigation bar (relation bar - relbar) at the top and bottom of all pages.

This can be used similar to ‘Quick Links’ e.g. adding a ‘toc’ or ‘api’ link

This extension reads the following conf.py options:

relbar_links_doc: a list of tuples mapping: lin-names to page-names

Important

path is entered relative to the conf.py and no extension

For example, the following snippet inserts two links:

toc: mapping the ‘contents’ page

api: mapping ‘api/api’ page

conf.py Usage Example:

# The api document: extension: relbar_links
relbar_links_doc = [
   ('toc', 'contents'),
   ('api', 'api/api'),
]