From a6548e4f11a4b41b489a413ed31188bfb012388a Mon Sep 17 00:00:00 2001 From: Nolan Brubaker Date: Wed, 19 Aug 2015 21:23:50 -0400 Subject: [PATCH] Move developer documentation to its own subtree Prior to this change, all files at the root of the doc/source/ directory were implied to be developer documentation. This commit moves them into an explicit subdirectory, and re-words the section headings to be less repetitive. No changes to formatting or content were introduced. Change-Id: Id00116ad2146f11df52dd8a331834719e1b8bd03 Closes-Bug: #1486789 --- doc/source/{ => developer-docs}/extending.rst | 0 doc/source/developer-docs/index.rst | 23 +++++++++++++++++++ doc/source/{ => developer-docs}/playbooks.rst | 4 ++-- doc/source/{ => developer-docs}/scripts.rst | 4 ++-- doc/source/index.rst | 4 +--- 5 files changed, 28 insertions(+), 7 deletions(-) rename doc/source/{ => developer-docs}/extending.rst (100%) create mode 100644 doc/source/developer-docs/index.rst rename doc/source/{ => developer-docs}/playbooks.rst (95%) rename doc/source/{ => developer-docs}/scripts.rst (97%) diff --git a/doc/source/extending.rst b/doc/source/developer-docs/extending.rst similarity index 100% rename from doc/source/extending.rst rename to doc/source/developer-docs/extending.rst diff --git a/doc/source/developer-docs/index.rst b/doc/source/developer-docs/index.rst new file mode 100644 index 0000000000..56b88fdf10 --- /dev/null +++ b/doc/source/developer-docs/index.rst @@ -0,0 +1,23 @@ +Developer Documentation +======================= + +In this section, you will find documentation relevant to developing +os-ansible-deployment. + +Contents: + +.. toctree:: + :maxdepth: 2 + + playbooks + extending + scripts + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/source/playbooks.rst b/doc/source/developer-docs/playbooks.rst similarity index 95% rename from doc/source/playbooks.rst rename to doc/source/developer-docs/playbooks.rst index d0128dab3d..f4a1a5d2f2 100644 --- a/doc/source/playbooks.rst +++ b/doc/source/developer-docs/playbooks.rst @@ -1,5 +1,5 @@ -os-ansible-deployment Playbooks -=============================== +Playbooks +========= The OpenStack Ansible playbooks are stored in the playbooks directory. diff --git a/doc/source/scripts.rst b/doc/source/developer-docs/scripts.rst similarity index 97% rename from doc/source/scripts.rst rename to doc/source/developer-docs/scripts.rst index 1dc41bad33..bea83e37e6 100644 --- a/doc/source/scripts.rst +++ b/doc/source/developer-docs/scripts.rst @@ -1,5 +1,5 @@ -OpenStack Ansible Deployment Scripts -==================================== +Included Scripts +================ The repository contains several helper scripts to manage gate jobs, install base requirements, and update repository information. Invoke diff --git a/doc/source/index.rst b/doc/source/index.rst index b811841e92..37fbd5a9b3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,10 +17,8 @@ Contents: .. toctree:: :maxdepth: 2 - playbooks install-guide/index - extending - scripts + developer-docs/index Indices and tables