Merge pull request #179 from cloudant/161-update-sphinx-docs-and-readthedocs-links

emlaver · emlaver · commit 3d1c1d9d0734 · 2016-06-03T09:32:28.000-04:00
Update library home documentation page and README readthedocs link
diff --git a/README.rst b/README.rst
@@ -11,7 +11,7 @@ Cloudant Python Client
 .. |docs| image:: https://readthedocs.org/projects/pip/badge/
     :alt: docs
     :scale: 100%
-    :target: http://python-cloudant.readthedocs.io/en/latest/default.html
+    :target: http://python-cloudant.readthedocs.io
 
 .. |compatibility| image:: https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg
     :alt: compatibility
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,7 +46,7 @@
 #source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'default'
+master_doc = 'index'
 
 # General information about the project.
 project = u'python-cloudant'
diff --git a/docs/default.rst b/docs/default.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,7 +1,14 @@
-index
-=====
+python-cloudant documentation
+=============================
+
+This is the official Cloudant client library for Python.
+
+.. toctree::
+   :maxdepth: 4
+
+   compatibility
+   getting_started
+   cloudant
+
+* :ref:`genindex`
 
-.. automodule:: cloudant.index
-    :members:
-    :undoc-members:
-    :show-inheritance:
diff --git a/docs/module_index.rst b/docs/module_index.rst
@@ -0,0 +1,7 @@
+index
+=====
+
+.. automodule:: cloudant.index
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/modules.rst b/docs/modules.rst
@@ -10,7 +10,7 @@ Modules
    design_document
    view
    query
-   index
+   module_index
    result
    replicator
    feed
