Package: ushahidi_sphinx_rtd_theme
OverviewThis is an Ushahidi extension of the existing them to allow customisation of the css features.Read the Docs Sphinx ThemeContentsOverviewRead the Docs Sphinx ThemeInstallationVia packageVia git or downloadChangelogHow the Table of Contents buildsContributing or modifying the themeSet up your environmentBefore you create an issueBefore you send a Pull RequestUsing this theme locally, then building on Read the Docs?TODOView a workingdemoover onreadthedocs.org.This is a mobile-friendlysphinxtheme I made forreadthedocs.org. It’s
currently in development there and includes some rtd variable checks that can be ignored
if you’re just trying to use it on your project outside of that site.This repo also exists as a submodule within the readthedocs itself, so please make your edits to
the SASS files here, rather than the .css files on RTD.InstallationVia packageDownload the package or add it to yourrequirements.txtfile:$pipinstallsphinx_rtd_themeIn yourconf.pyfile:importsphinx_rtd_themehtml_theme="sphinx_rtd_theme"html_theme_path=[sphinx_rtd_theme.get_html_theme_path()]Via git or downloadSymlink or subtree thesphinx_rtd_theme/sphinx_rtd_themerepository into your documentation atdocs/_themes/sphinx_rtd_themethen add the following two settings to your Sphinx
conf.py file:html_theme="sphinx_rtd_theme"html_theme_path=["_themes",]Changelogv0.1.8Start keeping changelog :)Support for third and fourth level headers in the sidebarAdd support for Sphinx 1.3Add sidebar headers for :caption: in Sphinx toctreeClean up sidebar scrolling behavior so it never scrolls out of viewHow the Table of Contents buildsCurrently the left menu will build based upon anytoctree(s)defined in your index.rst file.
It outputs 2 levels of depth, which should give your visitors a high level of access to your
docs. If no toctrees are set the theme reverts to sphinx’s usual local toctree.It’s important to note that if you don’t follow the same styling for your rST headers across
your documents, the toctree will misbuild, and the resulting menu might not show the correct
depth when it renders.Also note that the table of contents is set withincludehidden=true. This allows you
to set a hidden toc in your index file with thehiddenproperty that will allow you
to build a toc without it rendering in your index.By default, the navigation will “stick” to the screen as you scroll. However if your toc
is vertically too large, it will revert to static positioning. To disable the sticky nav
altogether change the setting inconf.py.Contributing or modifying the themeThe sphinx_rtd_theme is primarily asassproject that requires a few other sass libraries. I’m
usingbowerto manage these dependencies andsassto build the css. The good news is
I have a very nice set ofgruntoperations 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 environmentInstallsphinxinto a virtual environment.pip install sphinxInstall sassgem install sassInstall 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 installNow that our environment is set up, make sure you’re in your virtual environment, go to
this repository in your terminal and run grunt:gruntThis default task will do the followingvery 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.Before you create an issueI don’t have a lot of time to maintain this project due to other responsibilities.
I know there are a lot of Python engineers out there that can’t code sass / css and
are unable to submit pull requests. That said, submitting random style bugs without
at least providing sample documentation that replicates your problem is a good
way for me to ignore your request. RST unfortunately can spit out a lot of things
in a lot of ways. I don’t have time to research your problem for you, but I do
have time to fix the actual styling issue if you can replicate the problem for me.Before you send a Pull RequestWhen you’re done with your edits, you can rungrunt buildto clean out the old
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.# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.orgon_rtd=os.environ.get('READTHEDOCS',None)=='True'ifnoton_rtd:# only import and set the theme if we're building docs locallyimportsphinx_rtd_themehtml_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 itTODOSeparate some sass variables at the theme level so you can overwrite some basic colors.