Read the Docs Sphinx Theme by SEO Becak → link

This Sphinx theme was designed to provide a great reader experience for documentation users on both desktop and mobile devices. This theme is used primarily on Read the Docs but can work with any Sphinx project. You can find a working demo of the theme in the theme documentation

Installation

This theme is distributed on PyPI and can be installed with pip:

$ pip install sphinx-rtd-theme

To use the theme in your Sphinx project, you will need to add the following to your conf.py file:

import sphinx_rtd_theme

extensions = [
    ...
    "sphinx_rtd_theme",
]

html_theme = "sphinx_rtd_theme"

For more information read the full documentation on installing the theme

Configuration

This theme is highly customizable on both the page level and on a global level. To see all the possible configuration options, read the documentation on configuring the theme.

Contributing

If you would like to help modify or translate the theme, you’ll find more information on contributing in our contributing guide.

Theme Documentation

• Installation
  • Via Git or Download
  • Compatibility
• Configuration
  • Theme options
  • File-wide metadata
  • Other configuration
  • How the table of contents displays
• Contributing
  • Modifying the theme
  • Translations
  • Releasing the theme

Demo Documentation

• 1. Structural Elements
  • 1.1. Document Section
• 2. Structural Elements 2
  • 2.1. Document Section
• 3. Paragraph Level Markup
  • 3.1. Inline Markup
  • 3.2. Math
  • 3.3. Meta
  • 3.4. Blocks
  • 3.5. Sidebar
  • 3.6. References
  • 3.7. Directives
  • 3.8. Download Links
• 4. Lists & Tables
  • 4.1. Lists
  • 4.2. Tables
• 5. API documentation and generated content
  • 5.1. test_py_module
  • 5.2. C++ API
  • 5.3. JavaScript API
  • 5.4. Generated Index
  • 5.5. Optional parameter args
  • 5.6. Data

This is an incredibly long caption for a long menu

• 1. Long Sticky Nav
  • 1.1. Example Menu 1
  • 1.2. Example Menu 2
  • 1.3. Example Menu 3
  • 1.4. Example Menu 4
  • 1.5. Example Menu 5
  • 1.6. Example Menu 6
  • 1.7. Example Menu 7
  • 1.8. Example Menu 8
  • 1.9. Example Menu 9
  • 1.10. Example Menu 10
  • 1.11. Example Menu 11
  • 1.12. Example Menu 12
  • 1.13. Example Menu 13
  • 1.14. Example Menu 14
  • 1.15. Example Menu 15
  • 1.16. Example Menu 16
  • 1.17. Example Menu 17
  • 1.18. Example Menu 18
  • 1.19. Example Menu 19
  • 1.20. Example Menu 20
  • 1.21. Example Submenu 1
    • 1.21.1. Submenu 1
    • 1.21.2. Submenu 2
    • 1.21.3. Submenu 3
    • 1.21.4. Submenu 4
    • 1.21.5. Submenu 5
  • 1.22. Example Submenu 2
    • 1.22.1. Submenu 1
    • 1.22.2. Submenu 2
    • 1.22.3. Submenu 3
    • 1.22.4. Submenu 4
    • 1.22.5. Submenu 5