Fix Documentation process
PBR has been done changes that affects the way to generate the documentation. Those changes was causing failures because the API information was not created. So this change fixes the process that creates the documentation and fixes the syntax of the one of the titles of API document. Change-Id: I9e27897a5df0b2ddaca357f02568c7c97fc2453d
This commit is contained in:
parent
083e92713b
commit
a3f408d5b8
|
@ -1,5 +1,5 @@
|
||||||
The :mod:`tricircleclient` Python API
|
The :mod:`tricircleclient` Python API
|
||||||
====================================
|
=====================================
|
||||||
|
|
||||||
.. module:: tricircleclient
|
.. module:: tricircleclient
|
||||||
:synopsis: A client for the Tricircle API.
|
:synopsis: A client for the Tricircle API.
|
||||||
|
@ -21,6 +21,6 @@ Reference
|
||||||
For more information, see the reference:
|
For more information, see the reference:
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:glob:
|
||||||
|
|
||||||
api/autoindex
|
api/*
|
||||||
|
|
13
setup.cfg
13
setup.cfg
|
@ -57,3 +57,16 @@ doc =
|
||||||
|
|
||||||
[wheel]
|
[wheel]
|
||||||
universal = 1
|
universal = 1
|
||||||
|
|
||||||
|
[pbr]
|
||||||
|
autodoc_tree_index_modules = True
|
||||||
|
autodoc_tree_excludes =
|
||||||
|
setup.py
|
||||||
|
tricircleclient/tests/
|
||||||
|
api_doc_dir = api
|
||||||
|
|
||||||
|
[build_sphinx]
|
||||||
|
all-files = 1
|
||||||
|
build-dir = doc/build
|
||||||
|
source-dir = doc/source
|
||||||
|
warning-is-error = 1
|
||||||
|
|
2
tox.ini
2
tox.ini
|
@ -40,7 +40,7 @@ commands =
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
deps = -r{toxinidir}/doc/requirements.txt
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
commands = python setup.py build_sphinx
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
show-source = True
|
show-source = True
|
||||||
|
|
Loading…
Reference in New Issue