IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

rst fun for gh

Browse Source
This commit is contained in:
Dave Snider 2013-11-03 15:01:40 -08:00
parent 1817f2bab5
commit a708e0637f
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.rst
View File

@ -28,9 +28,9 @@ Symlink or subtree the ``dist/sphinx_rtd_theme`` repository into your documentat
``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx ``docs/_themes/sphinx_rtd_theme`` then add the following two settings to your Sphinx
conf.py file: conf.py file:
:: .. code-block::
html_theme = "sphinx_rtd_theme" html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ] html_theme_path = ["_themes", ]
How the Table of Contents builds How the Table of Contents builds
================================ ================================
@ -56,28 +56,28 @@ of a front-end developer (vs. that of a python developer). That means installing
Set up your environment Set up your environment
----------------------- -----------------------
1. Install sphinx_ into a virtual environment. You'll need a working python environment. 1. Install sphinx_ into a virtual environment.
:: .. code-block::
pip install sphinx pip install sphinx
2. Install node, bower and grunt. 2. Install node, bower and grunt.
:: .. code-block::
// Install node // Install node
brew install node brew install node
// Install node package manager // Install node package manager
curl https://npmjs.org/install.sh | sh curl https://npmjs.org/install.sh | sh
// Install bower and grunt // Install bower and grunt
npm install -g bower grunt-cli npm install -g bower grunt-cli
Now that our environment is set up, make sure you're in your virtual environment, go to 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 repository in your terminal and run grunt:
:: .. code-block::
grunt grunt
This default task will do the following **very cool things that make it worth the trouble**. This default task will do the following **very cool things that make it worth the trouble**.