Read the Docs Sphinx Theme

The sphinx_rtd_theme is a sphinx theme designed to look modern and be mobile-friendly. This theme is primary focused to be used on readthedocs.org but can work with your own sphinx projects. To read more and see a working demo head over to readthedocs.org.

Installing

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

pip install sphinx_rtd_theme

For more information read the full installing docs here.

Configuration

The sphinx_rtd_theme is highly customizable on both the page level and on a global level. To see all the possible configuration options read the configuring docs here.

Contributing

If you would like to help improve the theme or have more control over the theme in case of a fork please read our contributing guide here.

Theme Documentation

• Installation
  • Via Python Package
  • Via Git or Download
• Configuration
  • Project-wide Configuration
  • Page-level Configuration
  • How the Table of Contents builds
• Changelog
  • master
  • v0.3.0
  • v0.2.4
  • v0.2.3
  • v0.2.2
  • v0.2.1
  • v0.2.0
  • v0.1.10-alpha
  • v0.1.9
  • v0.1.8
• Contributing or modifying the theme
  • Set up your environment
  • Releasing the Theme

Demo Documents

• 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. test_py_module
  • 5.1. Generated Index
  • 5.2. Optional parameter args
  • 5.3. 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