2013-10-18 04:29:09 +08:00
|
|
|
.. _readthedocs.org: http://www.readthedocs.org
|
|
|
|
|
.. _bower: http://www.bower.io
|
|
|
|
|
.. _sphinx: http://www.sphinx-doc.org
|
|
|
|
|
.. _compass: http://www.compass-style.org
|
|
|
|
|
|
|
|
|
|
**************************
|
|
|
|
|
Read the Docs Sphinx Theme
|
|
|
|
|
**************************
|
|
|
|
|
|
2013-10-18 04:31:20 +08:00
|
|
|
This is a prototype mobile-friendly sphinx_ theme I made for readthedocs.org_. It's
|
2013-10-18 04:29:09 +08:00
|
|
|
currently in development and includes some rtd variable checks that can be ignored
|
|
|
|
|
if you're just tyring to use it on your project outside of that site.
|
|
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Symlink 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:
|
|
|
|
|
|
|
|
|
|
.. code-block::
|
|
|
|
|
|
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
|
html_theme_path = ["_themes", ]
|
|
|
|
|
|
|
|
|
|
Contributing or modifying the theme
|
|
|
|
|
===================================
|
|
|
|
|
|
2013-10-18 04:31:20 +08:00
|
|
|
To work on this theme you'll need to install bower_. Then simply run a ``bower install`` in the
|
2013-10-18 04:29:09 +08:00
|
|
|
root directory to install the dependencies. Once installed, make your sass changes to the
|
2013-10-18 04:31:20 +08:00
|
|
|
``sphix_rtd_theme/sass`` directory, making sure to use compass_ to compile down to css.
|
2013-10-18 04:29:09 +08:00
|
|
|
|
|
|
|
|
If you'd like to see your changes made to master, send me a pull request.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
