Fix building of documentation
Now both the standard command "python setup.py build_sphinx" and "tox -e docs" will build the documentation. The changes: * tox.ini: Fix docs section: Remove unneeded deps line, the general deps line is just fine. Enable the command, clean up before running sphinx and use the normal command for execution. * pydocs.rst: This throw an error while building since troveclient.client.Dbaas does not exist, replace it. * index.rst: Generate table of content. No need to include the files. Change-Id: I2095ef73a76b0212e33776af925f5eaf1810be7a Partial-Bug: #1315101
This commit is contained in:
@@ -15,13 +15,11 @@
|
||||
:start-line: 0
|
||||
:end-line: 22
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
.. contents:: Contents
|
||||
:local:
|
||||
|
||||
.. include:: ./usage.rst
|
||||
|
||||
.. include:: ./pydocs.rst
|
||||
usage
|
||||
pydocs
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
@@ -10,7 +10,7 @@ troveclient
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
.. autoclass:: troveclient.client.Dbaas
|
||||
.. autoclass:: troveclient.compat.client.Dbaas
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
9
tox.ini
9
tox.ini
@@ -28,12 +28,9 @@ commands = {posargs}
|
||||
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
||||
|
||||
[testenv:docs]
|
||||
-deps =
|
||||
coverage
|
||||
httplib2
|
||||
sphinx
|
||||
-commands =
|
||||
sphinx-build -b html {toxinidir}/docs/source {envtmpdir}/html
|
||||
commands =
|
||||
rm -rf doc/html doc/build
|
||||
python setup.py build_sphinx
|
||||
|
||||
[flake8]
|
||||
ignore = F821,H202,H306,H402,H404
|
||||
|
||||
Reference in New Issue
Block a user