Switch the docs theme to RTD default one, add RTD badge to README

README.rst

@@ -9,6 +9,10 @@ JSL
     :target: https://coveralls.io/r/aromanovich/jsl?branch=master
     :alt: Coverage
 
+.. image:: https://readthedocs.org/projects/jsl/badge/?version=latest
+    :target: https://readthedocs.org/projects/docs/
+    :alt: Documentation
+
 .. image:: http://img.shields.io/pypi/v/jsl.svg
     :target: https://pypi.python.org/pypi/jsl
     :alt: PyPI Version

docs/source/conf.py

@@ -2,16 +2,16 @@
 import sys
 import os
 
-import alabaster
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if not on_rtd:
+    import sphinx_rtd_theme
 
 sys.path.insert(0, os.path.abspath('../..'))
 import jsl
 
-
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
-    'alabaster',
 ]
 
 templates_path = ['_templates']
@@ -30,13 +30,9 @@
 
 # Options for HTML output
 
-html_theme = 'alabaster'
-html_theme_path = [alabaster.get_path()]
-html_theme_options = {
-    'github_user': 'aromanovich',
-    'github_repo': 'jsl',
-    'travis_button': True,
-}
+if not on_rtd:
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 html_static_path = ['_static']
 htmlhelp_basename = 'JSLdoc'
 html_sidebars = {
@@ -51,3 +47,6 @@
     ('index', 'jsl', u'JSL Documentation', [u'Anton Romanovich'], 1),
 ]
 
+
+
+

docs/source/index.rst

@@ -16,10 +16,6 @@ For an overview of JSL's basic functionality, please see the :doc:`tutorial`.
 
     tutorial
 
-
-API Documentation
------------------
-
 .. toctree::
     :caption: API Documentation
     :name: api-documentation

docs/source/tutorial.rst

@@ -40,8 +40,6 @@ It encourages the decomposition of large schemas into smaller readable pieces
 and makes schemas extendable using class inheritance. It enables the autocompleme
 feature or IDEs and makes any mistype in a JSON schema keyword cause a RuntimeError.
 
-Let's take a look at examples.
-
 .. links
 
 .. _Python implementation: https://python-jsonschema.readthedocs.org/en/latest/

requirements-dev.txt

@@ -3,5 +3,5 @@ coverage==3.7.1
 pytest==2.6.4
 pytest-cov==1.8.0
 Sphinx==1.3.1
-alabaster==0.7.4
+sphinx-rtd-theme==0.1.8
 mock==1.0.1