diff --git a/doc/source/conf.py b/doc/source/conf.py index d090984..f0840cb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -8,7 +8,7 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.viewcode', - 'oslo.sphinx' + 'oslosphinx', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -45,9 +45,9 @@ 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 = '_theme' -html_static_path = ['_static'] +#html_theme_path = ["."] +#html_theme = '_theme' +#html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..67f699a --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,24 @@ +=========================================== +Python Bindings to the OpenStack Ironic API +=========================================== + +This is a client for OpenStack `Ironic`_ API. There's a Python API +(the `ironicclient` modules), and a command-line script (installed as +`ironic`). + +Contents +======== + +.. toctree:: + :maxdepth: 1 + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + + +.. _Ironic: https://wiki.openstack.org/wiki/Ironic diff --git a/test-requirements.txt b/test-requirements.txt index f955dbd..f6df81d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,6 +4,7 @@ discover fixtures>=0.3.14 hacking>=0.8.0,<0.9 mock>=1.0 +oslosphinx python-subunit>=0.0.18 sphinx>=1.1.2,<1.2 testrepository>=0.0.18 diff --git a/tox.ini b/tox.ini index ead8433..5221534 100644 --- a/tox.ini +++ b/tox.ini @@ -5,6 +5,7 @@ skipsdist = True [testenv] setenv = VIRTUAL_ENV={envdir} +install_command = pip install -U {opts} {packages} deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt