Customization¶

Topbar Site Navigation¶

The topbar includes a menu to navigate the site table of contents. The name of this menu is Site by default. To change it, set the topbar_site_name option:

html_theme_options = { 'topbar_site_name': 'Site Navigation' }

To adjust the number of levels in the topbar site menu, set the topbar_site_depth option. The default value, -1, shows all levels.

Topbar Page Navigation¶

By default, the topbar also includes a menu to navigate the page table of contents. To disable this menu altogether, set the topbar_page option to False.

The name of the topbar page menu is Page by default. To change it, set the topbar_page_name option.

Topbar Relations¶

Be default, links to the previous and next pages are included by default on the right side of the topbar. To disable these pagination links, set the topbar_relations option to False.

Sidebar Contents¶

By default, the sidebar is empty. Add sidebar contents by populating the conf.py html_sidebars option. For example:

# Custom sidebar templates, maps document names to template names.
html_sidebars = {'**': ['localtoc.html',
        'relations.html',
        'sourcelink.html'],
    'index': [
        'globaltoc.html']
    }

Sidebar Location¶

To move the sidebar to the right, set the rightsidebar boolean in conf.py:

html_theme_options = { 'rightsidebar': True }