From 8455ebcf9dac74609f4c5f4aa760dd3dedb50b94 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Mon, 26 Jun 2017 15:57:47 -0400 Subject: [PATCH] move documentation into the new standard layout Change-Id: Ie16878c132794f74209d450670e12eaed80efd6a Signed-off-by: Doug Hellmann --- doc/source/index.rst | 8 ++------ doc/source/{installation.rst => install/index.rst} | 0 doc/source/{ref => reference}/backend.rst | 0 doc/source/{ref => reference}/forms.rst | 0 doc/source/reference/index.rst | 13 +++++++++++++ doc/source/{ref => reference}/user.rst | 0 doc/source/{ref => reference}/utils.rst | 0 doc/source/{ref => reference}/views.rst | 0 8 files changed, 15 insertions(+), 6 deletions(-) rename doc/source/{installation.rst => install/index.rst} (100%) rename doc/source/{ref => reference}/backend.rst (100%) rename doc/source/{ref => reference}/forms.rst (100%) create mode 100644 doc/source/reference/index.rst rename doc/source/{ref => reference}/user.rst (100%) rename doc/source/{ref => reference}/utils.rst (100%) rename doc/source/{ref => reference}/views.rst (100%) diff --git a/doc/source/index.rst b/doc/source/index.rst index b4404a27..d7f72c4a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,12 +11,8 @@ The current version is designed to work with the Keystone V2 or V3 API. .. toctree:: :maxdepth: 2 - installation - ref/user - ref/views - ref/forms - ref/backend - ref/utils + install/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/ref/backend.rst b/doc/source/reference/backend.rst similarity index 100% rename from doc/source/ref/backend.rst rename to doc/source/reference/backend.rst diff --git a/doc/source/ref/forms.rst b/doc/source/reference/forms.rst similarity index 100% rename from doc/source/ref/forms.rst rename to doc/source/reference/forms.rst diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst new file mode 100644 index 00000000..77a8e110 --- /dev/null +++ b/doc/source/reference/index.rst @@ -0,0 +1,13 @@ +===================================== + Django OpenStack Auth API Reference +===================================== + +.. toctree:: + :maxdepth: 2 + + user + views + forms + backend + utils + diff --git a/doc/source/ref/user.rst b/doc/source/reference/user.rst similarity index 100% rename from doc/source/ref/user.rst rename to doc/source/reference/user.rst diff --git a/doc/source/ref/utils.rst b/doc/source/reference/utils.rst similarity index 100% rename from doc/source/ref/utils.rst rename to doc/source/reference/utils.rst diff --git a/doc/source/ref/views.rst b/doc/source/reference/views.rst similarity index 100% rename from doc/source/ref/views.rst rename to doc/source/reference/views.rst