diff --git a/.gitignore b/.gitignore index a24c6443..6bc88f32 100644 --- a/.gitignore +++ b/.gitignore @@ -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 ac7b6bcf..00000000 --- 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 00000000..b1cd2f37 --- /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 69ed4fe6..00000000 --- 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 de4d9090..3876cddf 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 similarity index 100% rename from doc/source/installation.rst rename to doc/source/install/index.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..9eb4867e --- /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 similarity index 100% rename from doc/source/opts.rst rename to doc/source/reference/opts.rst diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 00000000..f69be70b --- /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 00000000..8cf52c99 --- /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 similarity index 100% rename from doc/source/usage.rst rename to doc/source/user/usage.rst diff --git a/setup.cfg b/setup.cfg index acd30c87..7cf82668 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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.*