Skip to content

buildthedocs/sphinx.theme

 
 

Repository files navigation

Build the Docs Sphinx Theme

To use this theme in your Sphinx project, extract the content to a dir, say _theme, and set variables html_theme_path and html_theme in the conf.py file. For example:

html_theme_path = ["."]
html_theme = '_theme'

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.

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

Who is using this theme?

About

Sphinx theme from ReadTheDocs adapted to be used on GitHub Pages

Resources

License

Code of conduct

Stars

Watchers

Forks

Languages

  • Sass 45.7%
  • HTML 24.9%
  • JavaScript 16.8%
  • Python 11.7%
  • Shell 0.9%