Bring doc build up to standard

Move the requirements definitions and documentation files to the
standard places used by other OpenStack projects so our doc publishing
jobs will work.

Remove the todo extension and all todo items from the documentation.

Change-Id: Iea630d827976fe517afacf4e373b3a125efff9c9

doc/source/conf.py

@@ -28,7 +28,7 @@ import subprocess
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo']
+extensions = ['sphinx.ext.autodoc', 'oslosphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -37,7 +37,7 @@ templates_path = ['_templates']
 source_suffix = '.rst'
 
 # The encoding of source files.
-# source_encoding = 'utf-8-sig'
+source_encoding = 'utf-8-sig'
 
 # The master toctree document.
 master_doc = 'index'
@@ -97,7 +97,7 @@ pygments_style = 'sphinx'
 
 # 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'
 
 # 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
@@ -126,7 +126,7 @@ html_theme = 'default'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

doc/source/index.rst

@@ -29,5 +29,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-.. todolist::

doc/source/interactive_mode.rst

@@ -13,8 +13,6 @@ the shell.
 
 .. _cmd2: http://packages.python.org/cmd2/index.html
 
-.. todo:: Add details about configuring and interacting with the shell (copy from cmd2 docs)
-
 Example
 =======
 

docs/requirements.txt

@@ -1,2 +0,0 @@
-httplib2==0.7.4
-Sphinx

setup.cfg

@@ -42,5 +42,5 @@ cliff.formatter.completion =
 
 [build_sphinx]
 all_files = 1
-build-dir = docs/build
-source-dir = docs/source
+build-dir = doc/build
+source-dir = doc/source

test-requirements.txt

@@ -4,3 +4,7 @@
 nose
 mock>=1.0
 coverage>=3.6
+# this is required for the docs build jobs
+sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+oslosphinx>=2.2.0  # Apache-2.0
+httplib2>=0.7.5

tox.ini

@@ -5,19 +5,17 @@ envlist = py33,py34,py26,py27,pypy,pep8
 distribute = False
 commands = nosetests -d --with-coverage --cover-inclusive --cover-package cliff []
 deps =
-    nose
-    mock
-    coverage
+  -r{toxinidir}/requirements.txt
+  -r{toxinidir}/test-requirements.txt
 
 [testenv:pep8]
 deps = flake8
-commands = flake8 cliff docs/source/conf.py setup.py
+commands = flake8 cliff doc/source/conf.py setup.py
 
 [testenv:py26]
 basepython=python2.6
 
 [testenv:venv]
-deps = -r{toxinidir}/docs/requirements.txt
 commands = {posargs}
 
 [testenv:neutronclient-stable]