diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2014-08-26 10:18:51 -0400 |
|---|---|---|
| committer | Doug Hellmann <doug@doughellmann.com> | 2014-08-26 17:33:01 -0400 |
| commit | b6c4489960f8ae96ddb2cd63c0068f7295dd69d1 (patch) | |
| tree | 75960e6aefd149e15cdfabcb4de5652354be72f5 /doc | |
| parent | fc156ec0697df542a1d377346e37de91a6e14cac (diff) | |
| download | oslo-middleware-b6c4489960f8ae96ddb2cd63c0068f7295dd69d1.tar.gz | |
Update docs for first release
Ensure each exported class has a docstring.
Add API to the sphinx docs.
Fix a few formatting issues so the rendered docs look OK.
Change-Id: Ieef7bae3783a084249169fe9b80ab17518eee15f
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/api.rst | 6 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 6 | ||||
| -rw-r--r-- | doc/source/index.rst | 16 | ||||
| -rw-r--r-- | doc/source/readme.rst | 1 | ||||
| -rw-r--r-- | doc/source/usage.rst | 7 |
5 files changed, 15 insertions, 21 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst new file mode 100644 index 0000000..db58162 --- /dev/null +++ b/doc/source/api.rst @@ -0,0 +1,6 @@ +===== + API +===== + +.. automodule:: oslo.middleware + :members: diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 8cb3146..2ca75d1 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1 +1,5 @@ -.. include:: ../../CONTRIBUTING.rst
\ No newline at end of file +============== + Contributing +============== + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 8aae142..390cea6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,19 +1,11 @@ -Welcome to oslo.middleware's documentation! -=========================================== +.. include:: ../../README.rst -Contents: +Contents +======== .. toctree:: :maxdepth: 2 - readme installation - usage + api contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 6b2b3ec..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../README.rst
\ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index 589e40f..0000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use oslo.middleware in a project:: - - import oslo.middleware
\ No newline at end of file |