Sphinx theme for http://docs.shishimao.com/
Project description
RealTimeCat Sphinx theme is a fork of the excellent sphinx_rtd_theme. See the documentation there for general information.
Stay in sync
In order to always stay in sync with the upstream sphinx_rtd_theme, this repository contains two remotes: upstream and origin. See Github’s syncing a fork article for more information.
Installation
Via package
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()]
Via git or download
Symlink or 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", ]
Editing
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.
Set up your environment
Install sphinx into a virtual environment.
pip install sphinx
Install sass
gem install sass
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.
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rtcat_sphinx_theme-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1fa5a03bb24158fe3531bc00f7f9890d07b643f2484dc3d9d79495374a1c6d9 |
|
MD5 | bd784fd00b4486ca355c1fadd4c0e651 |
|
BLAKE2b-256 | 6ab01d092da327e0cd9d27214923002a28ca9bec49dfc3462253fe2e27409739 |