Sphinx theme for http://docs.shishimao.com/
RealTimeCat Sphinx theme is a fork of the excellent sphinx_rtd_theme. See the documentation there for general information.
Download the package or add it to your requirements.txt file:
$ pip install rtcat_sphinx_theme
In your conf.py file:
import rtcat_sphinx_theme html_theme = "rtcat_sphinx_theme" html_theme_path = [rtcat_sphinx_theme.get_html_theme_path()]
Symlink or submodule/subtree the RTCat/rtcat_sphinx_theme repository into your documentation at docs/_themes/rtcat_sphinx_theme then add the following two settings to your Sphinx conf.py file:
html_theme = "rtcat_sphinx_theme" html_theme_path = ["_themes/rtcat_sphinx_theme", ]
The rtcat_sphinx_theme is primarily a sass project that requires a few other sass libraries. I’m using bower to manage these dependencies and sass to build the css. The good news is I have a very nice set of grunt operations that will not only load these dependencies, 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.
- Install sphinx into a virtual environment.
virtualenv ve source ve/bin/activate pip install sphinx
- Install sass
gem install sass
- Install node, bower and grunt.
// 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:
This default task will do the following very cool things that make it worth the trouble.
- It’ll install and update any bower dependencies.
- It’ll run sphinx and build new docs.
- It’ll watch for changes to the sass files and build css from the changes.
- It’ll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js or .css files.
|Filename, Size & Hash SHA256 Hash Help||File Type||Python Version||Upload Date|
(692.1 kB) Copy SHA256 Hash SHA256
|Wheel||py2.py3||Sep 11, 2016|
(696.3 kB) Copy SHA256 Hash SHA256
|Source||None||Sep 11, 2016|