diff options
| author | Dong Ma <winterma.dong@gmail.com> | 2017-07-01 01:07:04 +0800 |
|---|---|---|
| committer | Dong Ma <winterma.dong@gmail.com> | 2017-07-01 01:08:19 +0800 |
| commit | fe64db1d45fdf3ea9e6b9a7524d24f8626aae2af (patch) | |
| tree | c56354cac1de811bb358bfad63bebfd1e42ea097 | |
| parent | d17be6e20c82819714518d8459a8ab2e88453c13 (diff) | |
| download | oslo-db-fe64db1d45fdf3ea9e6b9a7524d24f8626aae2af.tar.gz | |
rearrange content to fit the new standard layout4.24.0
Change-Id: Idaa0dde5e4fd14213ae1611560897a27e9f72514
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | doc/source/contributing.rst | 1 | ||||
| -rw-r--r-- | doc/source/contributor/index.rst | 1 | ||||
| -rw-r--r-- | doc/source/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/index.rst | 17 | ||||
| -rw-r--r-- | doc/source/install/index.rst (renamed from doc/source/installation.rst) | 0 | ||||
| -rw-r--r-- | doc/source/reference/index.rst | 18 | ||||
| -rw-r--r-- | doc/source/reference/opts.rst (renamed from doc/source/opts.rst) | 0 | ||||
| -rw-r--r-- | doc/source/user/history.rst | 1 | ||||
| -rw-r--r-- | doc/source/user/index.rst | 9 | ||||
| -rw-r--r-- | doc/source/user/usage.rst (renamed from doc/source/usage.rst) | 0 | ||||
| -rw-r--r-- | setup.cfg | 1 |
12 files changed, 35 insertions, 16 deletions
@@ -18,4 +18,4 @@ ChangeLog .project .pydevproject oslo.db.egg-info/ -doc/source/api +doc/source/reference/api diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst deleted file mode 100644 index ac7b6bc..0000000 --- a/doc/source/contributing.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..b1cd2f3 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1 @@ +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe..0000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index de4d909..3876cdd 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -9,19 +9,10 @@ utils. .. toctree:: :maxdepth: 2 - installation - opts - usage - contributing - history - -API Documentation -================= - -.. toctree:: - :maxdepth: 1 - - api/autoindex + install/index + contributor/index + user/index + reference/index Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/install/index.rst index 1262160..1262160 100644 --- a/doc/source/installation.rst +++ b/doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 0000000..9eb4867 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,18 @@ +.. _using: + +========= +Reference +========= + +.. toctree:: + :maxdepth: 2 + + opts + +API +=== + +.. toctree:: + :maxdepth: 1 + + api/autoindex diff --git a/doc/source/opts.rst b/doc/source/reference/opts.rst index aa6f145..aa6f145 100644 --- a/doc/source/opts.rst +++ b/doc/source/reference/opts.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 0000000..f69be70 --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..8cf52c9 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,9 @@ +============== + Using oslo.db +============== + +.. toctree:: + :maxdepth: 2 + + usage + history diff --git a/doc/source/usage.rst b/doc/source/user/usage.rst index 1b2d996..1b2d996 100644 --- a/doc/source/usage.rst +++ b/doc/source/user/usage.rst @@ -92,5 +92,6 @@ output_file = oslo_db/locale/oslo_db.pot [pbr] warnerrors = True autodoc_index_modules = True +api_doc_dir = reference/api autodoc_exclude_modules = oslo_db.tests.* |