User Guide

The user guide describes how to use and customize this theme.

How the theme is structured

This theme converts all top-level toctree items into links in the header navigation bar. The sidebar will have no navigation links until one of these top-level links is active (e.g., if you are on a sub-page of a top-level link). Once one of the top-level links is active, the sidebar will be populated with a list of pages that are underneath the top-level page.

For example, see the links in the sidebar for the other pages in this section.

• Installation
  • Development version
• Configuration
  • Configure project logo and title
  • Configure default mode
  • Configure pygment theme
  • Configure icon links
  • Adding external links to your nav bar
  • Adding favicons
  • Configure the sidebar
  • Navigation depth and collapsing the sidebar
  • Hiding the previous and next buttons
  • Add a dropdown to switch between docs versions
  • Add an Edit this Page button
  • Configure the search bar position
  • Configure the search bar text
  • Google Analytics
  • Changing pages with keyboard presses
  • Show more levels of the in-page TOC by default
  • Remove the sidebar from some pages
  • Configure the navbar center alignment
  • Adding ethical advertisements to your sidebar in ReadTheDocs
  • Improve build speed and performance
• Add/Remove items from theme sections
  • The navbar items
  • The left sidebar
  • Left sidebar end sections
  • The right in-page sidebar
  • The footer
  • A list of built-in templates you can insert into sections
  • Add your own HTML templates to theme sections
• Customizing the theme
  • Custom CSS Stylesheets
  • Manage light and dark themes
  • CSS Theme variables
  • Change footer display
  • Replacing/Removing Fonts
• Accessibility
  • In Configuration
  • In Your Source
  • In the Browser
  • In Continuous Integration