Merge branch 'develop'

README.md

@@ -1,5 +1,7 @@
 # `Nefertari`
 [![Build Status](https://travis-ci.org/brandicted/nefertari.svg?branch=master)](https://travis-ci.org/brandicted/nefertari)
+[![Documentation Status](https://readthedocs.org/projects/nefertari/badge/?version=master)](https://readthedocs.org/projects/nefertari/?badge=master)
+
 
 Nefertari is a REST API framework sitting on top of [Pyramid](https://github.com/Pylons/pyramid) and [ElasticSearch](https://www.elastic.co/downloads/elasticsearch). She currently offers two backend engines: [SQLA](https://github.com/brandicted/nefertari-sqla) and [MongoDB](https://github.com/brandicted/nefertari-mongodb).
 

docs/source/conf.py

@@ -31,7 +31,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinxcontrib.fulltoc',
+    # 'sphinxcontrib.fulltoc',
     'releases'
 ]
 
@@ -113,6 +113,16 @@
 
 # -- Options for HTML output ----------------------------------------------
 
+# 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
+
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 # html_theme = 'alabaster'