From 0482faa2e2182468e275b7eb7340419961ea4170 Mon Sep 17 00:00:00 2001 From: Dave Snider Date: Wed, 11 Dec 2013 09:37:38 -0800 Subject: [PATCH] add note about running locally. fixes #68 --- README.rst | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 76027ed2..bb6f3ec0 100644 --- a/README.rst +++ b/README.rst @@ -133,9 +133,28 @@ When you're done with your edits, you can run ``grunt build`` to clean out the o files and rebuild a new distribution, compressing the css and cleaning out extraneous files. Please do this before you send in a PR. +Using this theme locally, then building on Read the Docs? +========================================================== + +Currently if you import sphinx_rtd_theme in your local sphinx build, then pass +that same config to Read the Docs, it will fail, since RTD gets confused. If +you want to run this theme locally and then also have it build on RTD, then +you can add something like this to your config. Thanks to Daniel Oaks for this. + +.. code:: python + + # on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org + on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + + if not on_rtd: # only import and set the theme if we're building docs locally + import sphinx_rtd_theme + html_theme = 'sphinx_rtd_theme' + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + + # otherwise, readthedocs.org uses their theme by default, so no need to specify it + 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. +