3 Commits

Author SHA1 Message Date
Masayuki Igawa
5b8f5dffbe Fix docs warnings and errors
This commit fixes docs and warnings. But I left some warnings such as
ChangeLog and external image URIs. Because ChangeLog is generated from
git log. And to fix the external image URIs, it needs needs an ugly
workaround that is replacing it to raw html.

Change-Id: Ieecc640fdf5d54d138eeb963ff9ef8cd1c9eaa4a
2016-05-31 04:36:39 +00:00
Matthew Treinish
a08a7afa81 Update the documentation
This commit updates the documentation for subunit2sql. It adds details
to the README around running setting up the DB and running subunit2sql.
Also, the db api autodoc usage is corrected so that it properly
generates the documentation. Finally, the sphinx theme is switched to
oslosphinx to have consistent style with the documentation for the
other OpenStack projects.

Related-Bug: #1348202
Change-Id: Icf148dee19bb888b551e60a396f87f6c09553e09
2014-07-27 13:15:12 -04:00
Matthew Treinish
efae453856 Add sphinx docs
This commit actually adds support for building the docs with sphinx.
Before we had a tox job for building docs but there wasn't actually
anything to build.
2014-06-24 16:21:38 -04:00