documentation cleanup

Remove OpenStack style and add autodoc.

Change-Id: I485fcd412ef6df7e7723619b3ee3307d2f5b288e

doc/source/conf.py

@@ -15,7 +15,7 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath('../..'))
+sys.path.insert(0, os.path.abspath('../../'))
 # -- General configuration ----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
@@ -23,7 +23,6 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx'
 ]
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -40,6 +39,12 @@ master_doc = 'index'
 project = u'ooi'
 copyright = u'2014-present, Spanish National Research Council - CSIC'
 
+from ooi.version import version_info
+# The full version, including alpha/beta/rc tags.
+release = version_info.release_string()
+# The short X.Y version.
+version = version_info.version_string()
+
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = True
 
@@ -55,6 +60,7 @@ pygments_style = 'sphinx'
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
 # html_theme_path = ["."]
+html_theme = 'haiku'
 # html_theme = '_theme'
 # html_static_path = ['static']
 

doc/source/developer.rst

@@ -0,0 +1,7 @@
+Developer documentation
+=======================
+
+.. toctree::
+    :maxdepth: 1
+
+    modules

doc/source/index.rst

@@ -1,8 +1,3 @@
-.. ooi documentation master file, created by
-   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to ooi's documentation!
 ========================================================
 
@@ -12,12 +7,20 @@ ooi is an implementation the Open Grid Forum's `Open Cloud Computing Interface
 .. _Open Cloud Computing Interface (OCCI): http://www.occi-wg.org
 .. _OpenStack: http://www.openstack.org
 
-Contents:
 
+User documentation
+------------------
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
-   installation
+    user
+
+Developer documentation
+----------------------
+.. toctree::
+    :maxdepth: 2
+
+    developer
 
 Indices and tables
 ==================

doc/source/modules.rst

@@ -0,0 +1,7 @@
+ooi's modules
+=============
+
+.. toctree::
+    :maxdepth: 2
+
+    api/autoindex

doc/source/user.rst

@@ -0,0 +1,7 @@
+User documentation
+==================
+
+.. toctree::
+   :maxdepth: 2
+
+   installation

setup.cfg

@@ -47,3 +47,11 @@ output_file = ooi/locale/ooi.pot
 [entry_points]
 paste.filter_factory =
     ooi = ooi.wsgi:OCCIMiddleware.factory
+
+[pbr]
+# Have pbr generate the module indexes like sphinx autodoc
+autodoc_index_modules = True
+    
+# Exclude modules that won't build with autodoc (or that we don't want doc'ed);
+# this requires updating the exclude_patterns variable in doc/source/conf.py
+autodoc_exclude_modules = ooi.tests.*

test-requirements.txt

@@ -4,7 +4,6 @@ discover
 fixtures>=0.3.14
 python-subunit>=0.0.18
 sphinx>=1.1.2
-oslosphinx
 testrepository>=0.0.18
 testscenarios>=0.4
 testtools>=0.9.34