Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Sphinx theme for readthedocs.org
Pull request Compare This branch is 198 commits behind snide:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
demo_docs
sass
sphinx_rtd_theme
.gitignore
Gemfile
Gemfile.lock
Gruntfile.js
LICENSE
MANIFEST.in
README.rst
bower.json
compass.rb
package.json
requirements.txt
screen_desktop.png
screen_mobile.png
setup.py

README.rst

Read the Docs Sphinx Theme

View a working demo over on readthedocs.org.

This is a prototype mobile-friendly sphinx theme I made for readthedocs.org. It's currently in development and includes some rtd variable checks that can be ignored if you're just trying to use it on your project outside of that site.

screen_mobile.png

Installation

Via package

Download the package or add it to your requirements.txt file:

$ pip install sphinx_rtd_theme

In your conf.py file:

import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"

html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Via git or download

Symlink or subtree the sphinx_rtd_theme/sphinx_rtd_theme repository into your documentation at docs/_themes/sphinx_rtd_theme then add the following two settings to your Sphinx conf.py file:

html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]

How the Table of Contents builds

Currently the left menu will build based upon any toctree(s) defined in your index.rst file. It outputs 2 levels of depth, which should give your visitors a high level of access to your docs. If no toctrees are set the theme reverts to sphinx's usual local toctree.

It's important to note that if you don't follow the same styling for your rST headers across your documents, the toctree will misbuild, and the resulting menu might not show the correct depth when it renders.

Contributing or modifying the theme

The sphinx_rtd_theme is primarily a sass project that requires a few other sass libraries. I'm using bower to manage these dependencies and compass to build the css. The good news is I have a very nice set of grunt operations that will not only load these dependecies, but watch for changes, rebuild the sphinx demo docs and build a distributable version of the theme. The bad news is this means you'll need to set up your environment similar to that of a front-end developer (vs. that of a python developer). That means installing node and ruby.

Set up your environment

  1. Install sphinx into a virtual environment.
pip install sphinx
  1. Install sass and compass
gem install sass compass
  1. Install node, bower and grunt.
// Install node
brew install node

// Install bower and grunt
npm install -g bower grunt-cli

// Now that everything is installed, let's install the theme dependecies.
npm install

Now that our environment is set up, make sure you're in your virtual environment, go to this repository in your terminal and run grunt:

grunt

This default task will do the following very cool things that make it worth the trouble.

  1. It'll install and update any bower dependencies.
  2. It'll run sphinx and build new docs.
  3. It'll watch for changes to the sass files and build css from the changes.
  4. It'll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js or .css files.

Before you send a Pull Request

When you're done with your edits, you can run grunt build to clean out the old files and rebuild a new distribution, compressing the css and cleaning out extraneous files. Please do this before you send in a PR.

TODO

  • Build real demo docs with lots of rst examples
  • Update to font-awesome 4.0 and have it build from bower, not the copy/paste hack I have now.
  • Separate some sass variables at the theme level so you can overwrite some basic colors.
  • Add the ability to set a logo.
Something went wrong with that request. Please try again.