summaryrefslogtreecommitdiff
path: root/setup.cfg
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2014-09-01 16:33:18 -0400
committerDoug Hellmann <doug@doughellmann.com>2014-09-04 16:27:00 -0400
commitcae12025a90995d06217385a80c4210614b542f8 (patch)
tree3abac77cedf87077018aad0b13580c9529947ee8 /setup.cfg
parentbe6f9a0ff7da10bd272c369d97058bf3546fc508 (diff)
downloadoslo-db-cae12025a90995d06217385a80c4210614b542f8.tar.gz
Clean up documentation
Switch to manually generated rst files for the API documentation so we do not expose private parts of the library. Fix formatting of usage.rst Convert bullet list to section headers to fix rendering issues and make the docs more readable. Fix formatting of docstrings in classes exposed in the docs to eliminate warnings/errors from Sphinx. Add history.rst Change-Id: I6f500775f801558f7c0c29f180b60f83a7150e02
Diffstat (limited to 'setup.cfg')
-rw-r--r--setup.cfg2
1 files changed, 1 insertions, 1 deletions
diff --git a/setup.cfg b/setup.cfg
index 78097e8..119e2a8 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -59,4 +59,4 @@ output_file = oslo.db/locale/oslo.db.pot
# NOTE(viktors): uncomment ``warnerrors`` line, when setup.cfg we then
# want to treat sphinx warnings as errors
# warnerrors = True
-autodoc_index_modules = True
+#autodoc_index_modules = True