requiremets.txt: add sphinx_rtd_theme &&

conf.py: use rtd theme outside of rtd && .gitignore: add conf/ & logs/
This commit is contained in:
Mikaela Suomalainen 2014-08-31 14:40:44 +03:00
parent 7bc92b9ce7
commit e8cf4c4ab5
3 changed files with 14 additions and 1 deletions

2
.gitignore vendored
View File

@ -2,3 +2,5 @@
*.swp
*.swo
_build
conf/
logs/

12
conf.py
View File

@ -13,6 +13,16 @@
import sys, os
# 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
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@ -91,7 +101,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
#html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the

View File

@ -1,2 +1,3 @@
sphinx
sphinx_rtd_theme
git+https://github.com/ProgVal/Limnoria.git@testing