WIP

README.rst

@@ -1,22 +1,22 @@
 .. image:: https://cloud.githubusercontent.com/assets/2701938/17723092/47302008-6405-11e6-85e8-35ad8dfac30b.png
 
-Python Driver for ArangoDB
---------------------------
 
 Welcome to the GitHub page for **python-arango**, a Python driver for
 `ArangoDB's REST API <https://www.arangodb.com/>`__.
 
-Features:
+Features
+========
 
-    - Clean, Pythonic API
-    - Lightweight
-    - Robust documentation
-    - 95%+ API coverage
+- Clean, Pythonic interface
+- Lightweight
+- 95%+ API coverage
 
-Compatibility:
+Compatibility
+=============
 
-    - Compatible with Python 2.7, 3.4 and 3.5
-    - Latest version of python-arango is compatible with ArangoDB 3.x only
+- Tested with Python versions 2.7.x, 3.4.x and 3.5.x
+- Latest version of python-arango (3.x) works with ArangoDB 3.x only
+- Older versions of python-arango (2.x) work with ArangoDB 2.x only
 
 Installation
 ============
@@ -25,7 +25,6 @@ To install a stable version from PyPi_:
 
 .. code-block:: bash
 
-    # You may need to use sudo depending on your environment
     pip install python-arango
 
 
@@ -35,10 +34,10 @@ To install the latest version directly from GitHub_:
 
     git clone https://github.com/joowani/python-arango.git
     cd python-arango
-    
-    # You may need to use sudo depending on your environment
     python setup.py install
 
+You may need to use ``sudo`` depending on your environment.
+
 .. _PyPi: https://pypi.python.org/pypi/python-arango
 .. _GitHub: https://github.com/joowani/python-arango
 
@@ -87,6 +86,7 @@ communicate with an ArangoDB server:
     # Truncate the collection
     students.truncate()
 
-Please view the full `API documentation`_ for more details.
+Please read the full `API documentation`_ for more details.
 
-.. _API documentation: https://pypi.python.org/pypi/python-arango
+.. _API documentation:
+    http://python-driver-for-arangodb.readthedocs.io/en/latest/intro.html

docs/conf.py

@@ -18,8 +18,12 @@
 #
 import os
 import sys
+
+from arango.version import VERSION
+
 sys.path.insert(0, os.path.abspath('../arango'))
 
+
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -37,7 +41,7 @@
 ]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -50,7 +54,7 @@
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'master'
+master_doc = 'intro'
 
 # General information about the project.
 project = u'python-arango'
@@ -62,9 +66,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = u'3.0.0'
+version = VERSION
 # The full version, including alpha/beta/rc tags.
-release = u'3.0.0'
+release = VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/master.rst → docs/intro.rst

@@ -10,39 +10,40 @@
 Welcome to the documentation for **python-arango**, a Python driver for
 `ArangoDB's REST API <https://www.arangodb.com/>`__.
 
-Introduction
-============
+Features
+========
 
-Project **python-arango** has the following features:
+- Clean, Pythonic interface
+- Lightweight
+- 95%+ API coverage
 
-    - Clean, Pythonic API
-    - Lightweight
-    - 95%+ API coverage
-    - Compatible with Python 2.7, 3.4 and 3.5
+Compatibility
+=============
 
-Latest version of python-arango is compatible with ArangoDB 3.x only
+- Tested with Python versions 2.7.x, 3.4.x and 3.5.x
+- Latest version of python-arango (3.x) works with ArangoDB 3.x only
+- Older versions of python-arango (2.x) work with ArangoDB 2.x only
 
 Installation
 ============
 
-To install a stable version from PyPI_:
+To install a stable version from PyPi_:
 
 .. code-block:: bash
 
-    # You may need to use sudo depending on your environment
     pip install python-arango
 
 
-To install the latest version from GitHub_:
+To install the latest version directly from GitHub_:
 
 .. code-block:: bash
 
     git clone https://github.com/joowani/python-arango.git
     cd python-arango
-
-    # You may need to use sudo depending on your environment
     python setup.py install
 
+You may need to use ``sudo`` depending on your environment.
+
 .. _PyPi: https://pypi.python.org/pypi/python-arango
 .. _GitHub: https://github.com/joowani/python-arango