From cdb50bed6e76930f1b0f4c6272166880ef5304ed Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Wed, 5 Jul 2017 01:54:52 +0900 Subject: [PATCH] rearrange the documentation to fit into the new standard layout Change-Id: If9bd83a0ac47084e025899cee681feef06265406 --- .../{contributing.rst => contributor/index.rst} | 2 +- doc/source/history.rst | 1 - doc/source/index.rst | 10 ++++------ .../{installation.rst => install/index.rst} | 0 doc/source/{api => reference}/context.rst | 0 doc/source/{api => reference}/fixture.rst | 0 doc/source/{api => reference}/index.rst | 6 +++--- doc/source/{ => user}/examples.rst | 0 doc/source/{ => user}/examples/usage.py | 0 doc/source/{ => user}/examples/usage_simple.py | 0 .../{ => user}/examples/usage_user_identity.py | 0 doc/source/user/history.rst | 1 + doc/source/user/index.rst | 15 +++++++++++++++ doc/source/{ => user}/usage.rst | 0 14 files changed, 24 insertions(+), 11 deletions(-) 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%) rename doc/source/{api => reference}/context.rst (100%) rename doc/source/{api => reference}/fixture.rst (100%) rename doc/source/{api => reference}/index.rst (52%) rename doc/source/{ => user}/examples.rst (100%) rename doc/source/{ => user}/examples/usage.py (100%) rename doc/source/{ => user}/examples/usage_simple.py (100%) rename doc/source/{ => user}/examples/usage_user_identity.py (100%) 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/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 2ca75d1..ed5290b 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 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 411f6f3..ec2f4f2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,11 +5,9 @@ Contents: .. toctree:: :maxdepth: 2 - installation - usage - examples - contributing - history + install/index + user/index + contributor/index Code Documentation ================== @@ -17,7 +15,7 @@ Code Documentation .. toctree:: :maxdepth: 1 - api/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/api/context.rst b/doc/source/reference/context.rst similarity index 100% rename from doc/source/api/context.rst rename to doc/source/reference/context.rst diff --git a/doc/source/api/fixture.rst b/doc/source/reference/fixture.rst similarity index 100% rename from doc/source/api/fixture.rst rename to doc/source/reference/fixture.rst diff --git a/doc/source/api/index.rst b/doc/source/reference/index.rst similarity index 52% rename from doc/source/api/index.rst rename to doc/source/reference/index.rst index a123a00..878a0dc 100644 --- a/doc/source/api/index.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -================== - oslo.context API -================== +============= +API reference +============= .. toctree:: :maxdepth: 1 diff --git a/doc/source/examples.rst b/doc/source/user/examples.rst similarity index 100% rename from doc/source/examples.rst rename to doc/source/user/examples.rst diff --git a/doc/source/examples/usage.py b/doc/source/user/examples/usage.py similarity index 100% rename from doc/source/examples/usage.py rename to doc/source/user/examples/usage.py diff --git a/doc/source/examples/usage_simple.py b/doc/source/user/examples/usage_simple.py similarity index 100% rename from doc/source/examples/usage_simple.py rename to doc/source/user/examples/usage_simple.py diff --git a/doc/source/examples/usage_user_identity.py b/doc/source/user/examples/usage_user_identity.py similarity index 100% rename from doc/source/examples/usage_user_identity.py rename to doc/source/user/examples/usage_user_identity.py 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..366d03c --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,15 @@ +================== +Using oslo.context +================== + +.. toctree:: + :maxdepth: 2 + + usage + examples + +.. history contains a lot of sections, toctree with maxdepth 1 is used. +.. 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