From 3a9c7fb9f764bf23bbad291d0d357b5d5934dea3 Mon Sep 17 00:00:00 2001 From: Tom Barron Date: Mon, 7 Aug 2017 07:05:35 -0400 Subject: [PATCH] doc migration: new directory layout This patch introduces a new directory layout in doc/source in conformance with the OpenStack manuals project migration spec [1], moves the existing content in manila/doc/source into the new directories, and adjusts index files accordingly. This is the first step in the migration process as outlined in the spec. [1] https://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Partial-Bug: #1706181 Change-Id: I6b876f6e697659a5fe7046d5c5d4fd4ed98f9828 Needed-By: If13ebd1ede6fbc997d74425ec78e15621f1f80b2 Depends-On: I834fbef9783739fd664246ff710df1ab42ce2af5 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 --- doc/source/{ => contributor}/contributing.rst | 2 +- doc/source/contributor/readme.rst | 1 + doc/source/index.rst | 6 +++--- doc/source/readme.rst | 1 - 4 files changed, 5 insertions(+), 5 deletions(-) rename doc/source/{ => contributor}/contributing.rst (50%) create mode 100644 doc/source/contributor/readme.rst delete mode 100644 doc/source/readme.rst diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst similarity index 50% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst index ed77c12..2aa0707 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributor/contributing.rst @@ -1,4 +1,4 @@ ============ Contributing ============ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file +.. include:: ../../../CONTRIBUTING.rst diff --git a/doc/source/contributor/readme.rst b/doc/source/contributor/readme.rst new file mode 100644 index 0000000..e4a3ad5 --- /dev/null +++ b/doc/source/contributor/readme.rst @@ -0,0 +1 @@ +.. include:: ../../../README.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 1429ffd..aefcc8e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,15 +4,15 @@ contain the root `toctree` directive. Welcome to manila-image-elements documentation! -======================================================== +=============================================== Contents: .. toctree:: :maxdepth: 2 - readme - contributing + contributor/readme + contributor/contributing Indices and tables ================== diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index 38ba804..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst \ No newline at end of file