From a2335dbb698a9507057cd0e3c63810064069adc8 Mon Sep 17 00:00:00 2001 From: Dong Ma Date: Thu, 6 Jul 2017 23:43:58 +0800 Subject: [PATCH] rearrange content to fit the new standard layout Change-Id: I5cbe836cf54f752eb4f93e105ffb49b387440db7 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 --- .gitignore | 2 +- doc/source/{opts.rst => configuration/index.rst} | 0 .../{contributing.rst => contributor/index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 11 +++++------ doc/source/{installation.rst => install/index.rst} | 0 doc/source/reference/index.rst | 10 ++++++++++ doc/source/user/history.rst | 1 + doc/source/user/index.rst | 13 +++++++++++++ doc/source/{ => user}/usage.rst | 0 setup.cfg | 1 + 11 files changed, 32 insertions(+), 9 deletions(-) rename doc/source/{opts.rst => configuration/index.rst} (100%) rename doc/source/{contributing.rst => contributor/index.rst} (53%) delete mode 100644 doc/source/history.rst rename doc/source/{installation.rst => install/index.rst} (100%) create mode 100644 doc/source/reference/index.rst create mode 100644 doc/source/user/history.rst create mode 100644 doc/source/user/index.rst rename doc/source/{ => user}/usage.rst (100%) diff --git a/.gitignore b/.gitignore index dba59ee2..94eea934 100644 --- a/.gitignore +++ b/.gitignore @@ -41,7 +41,7 @@ output/*/index.html # Sphinx doc/build -doc/source/api +doc/source/reference/api # pbr generates these AUTHORS diff --git a/doc/source/opts.rst b/doc/source/configuration/index.rst similarity index 100% rename from doc/source/opts.rst rename to doc/source/configuration/index.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/index.rst similarity index 53% rename from doc/source/contributing.rst rename to doc/source/contributor/index.rst index 2ca75d1b..ed5290bb 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/index.rst @@ -2,4 +2,4 @@ Contributing ============== -.. include:: ../../CONTRIBUTING.rst +.. 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 9d47df5b..0f85a437 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -10,12 +10,11 @@ Contents .. toctree:: :maxdepth: 2 - installation - api/modules - usage - opts - contributing - history + install/index + contributor/index + configuration/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..65d9a527 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,10 @@ +.. _using: + +========= +Reference +========= + +.. toctree:: + :maxdepth: 2 + + api/modules 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..cd5f00b4 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,13 @@ +================ +Using oslo.cache +================ + +.. toctree:: + :maxdepth: 2 + + usage + +.. toctree:: + :maxdepth: 1 + + 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 8dcc37db..edb7f0cb 100644 --- a/setup.cfg +++ b/setup.cfg @@ -43,6 +43,7 @@ etcd3gw = [pbr] warnerrors = true autodoc_tree_index_modules = True +api_doc_dir = reference/api [build_sphinx] source-dir = doc/source