Improve Sphinx generated docs (better navigation)

areski · areski · commit 7d73bf117773 · 2014-10-22T23:24:51.000+02:00
diff --git a/README.rst b/README.rst
@@ -1,5 +1,4 @@
-InfluxDB-Python
-===============
+
 
 InfluxDB-Python is a client for interacting with InfluxDB_.
 
@@ -22,10 +21,13 @@ InfluxDB-Python is a client for interacting with InfluxDB_.
     :target: https://pypi.python.org/pypi/influxdb/
     :alt: License
 
+.. _readme-about:
 
 InfluxDB is an open-source distributed time series database, find more about InfluxDB_ at http://influxdb.com/
 
 
+.. _installation:
+
 Installation
 ============
 
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -2,3 +2,4 @@ requests
 nose
 mock
 Sphinx==1.2.3
+sphinx_rtd_theme
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -12,6 +12,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import sphinx_rtd_theme
 import sys
 import os
 
@@ -104,7 +105,8 @@
 
 # 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'
+html_theme = "sphinx_rtd_theme"
 
 # 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
@@ -113,6 +115,7 @@
 
 # Add any paths that contain custom themes here, relative to this directory.
 #html_theme_path = []
+html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
diff --git a/docs/source/include-readme.rst b/docs/source/include-readme.rst
@@ -0,0 +1,8 @@
+
+.. _influxdb-python:
+
+===============
+InfluxDB-Python
+===============
+
+.. include:: ../../README.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -10,7 +10,10 @@ Welcome to InfluxDB's documentation!
 :Date: |today|
 :Keywords: python, time series, database
 
-.. include:: ../../README.rst
+.. toctree::
+    :maxdepth: 2
+
+    include-readme
 
 
 Contents:
