diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2014-09-01 16:33:18 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2014-09-04 16:27:00 -0400 |
| commit | cae12025a90995d06217385a80c4210614b542f8 (patch) | |
| tree | 3abac77cedf87077018aad0b13580c9529947ee8 /doc/source/index.rst | |
| parent | be6f9a0ff7da10bd272c369d97058bf3546fc508 (diff) | |
| download | oslo-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 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 037fe74..5e96766 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,21 @@ -Welcome to oslo.db documentation! -================================= +========= + oslo.db +========= The Oslo database handling library. Provides database connectivity to the different backends and helper utils. -Contents: ---------- +Contents +-------- .. toctree:: :maxdepth: 2 - readme installation usage + api/index contributing + history Indices and tables ------------------ |