diff options
author | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-06-09 15:15:30 -0400 |
---|---|---|
committer | Doug Hellmann <doug.hellmann@dreamhost.com> | 2014-06-23 08:18:21 -0700 |
commit | aec9e529fd72924cb8f3f149d35a6b9ce0581c81 (patch) | |
tree | 1ed463b18e482f15cb2f92d754c90b7bc351a9b2 /tox.ini | |
parent | 3f6b7424ffb6e576b50346f338d64cc5e8289e6a (diff) | |
download | oslotest-aec9e529fd72924cb8f3f149d35a6b9ce0581c81.tar.gz |
Add API documentation
Add docstrings and sphinx structure to expose them through the developer
docs for the library.
Also add a 'docs' target in tox.ini to make building the documentation
locally easier.
Remove the nearly useless usage.rst file.
Turn on the pbr flag to treat doc build warnings as errors.
Closes-bug: #1329952
Change-Id: I274a4144edf4efe9ed786e220e40003fda6f99e0
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 3 |
1 files changed, 3 insertions, 0 deletions
@@ -23,6 +23,9 @@ commands = [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [flake8] show-source = True exclude = .tox,dist,doc,*.egg,build |