From 545215317d853ea9edad75fc3667c8fe590e2fe4 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 7 May 2014 08:21:55 -0700 Subject: [PATCH] create initial structure Set up the initial structure with a juno directory, several toctrees, etc. Tweak the document template. Change-Id: I9b499ee9e7b9ded9ae5418dda09f8b0c6991b143 --- doc/source/index.rst | 9 +++++---- doc/source/specs | 1 + doc/source/template.rst | 19 ++++++++++++------- specs/.gitignore | 0 specs/index.rst | 9 +++++++++ specs/juno/index.rst | 11 +++++++++++ 6 files changed, 38 insertions(+), 11 deletions(-) create mode 120000 doc/source/specs delete mode 100644 specs/.gitignore create mode 100644 specs/index.rst create mode 100644 specs/juno/index.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 1ee41bb..8513e6b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,18 +3,19 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -oslo-specs Design Specifications -================================================== +============================ + Oslo Design Specifications +============================ .. toctree:: :glob: :maxdepth: 2 - ../../specs/* + specs/* oslo-specs Repository Information -=================================================== +================================= .. toctree:: :maxdepth: 2 diff --git a/doc/source/specs b/doc/source/specs new file mode 120000 index 0000000..87a4030 --- /dev/null +++ b/doc/source/specs @@ -0,0 +1 @@ +../../specs \ No newline at end of file diff --git a/doc/source/template.rst b/doc/source/template.rst index b548b47..805eb88 100644 --- a/doc/source/template.rst +++ b/doc/source/template.rst @@ -1,14 +1,12 @@ -:: - -This work is licensed under a Creative Commons Attribution 3.0 Unported License. -http://creativecommons.org/licenses/by/3.0/legalcode - .. This template should be in ReSTructured text. The filename in the git repository should match the launchpad URL, for example a URL of https://blueprints.launchpad.net/oslo/+spec/awesome-thing should be named - awesome-thing.rst . Please do not delete any of the sections in this + awesome-thing.rst. + + Please do not delete any of the sections in this template. If you have nothing to say for a whole section, just write: None + For help with syntax, see http://sphinx-doc.org/rest.html To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html @@ -83,4 +81,11 @@ Dependencies projects, that this one either depends on or is related to. - Does this feature require any new library dependencies or code otherwise not - included in OpenStack? Or does it depend on a specific version of library? \ No newline at end of file + included in OpenStack? Or does it depend on a specific version of library? + +.. note:: + + This work is licensed under a Creative Commons Attribution 3.0 + Unported License. + http://creativecommons.org/licenses/by/3.0/legalcode + diff --git a/specs/.gitignore b/specs/.gitignore deleted file mode 100644 index e69de29..0000000 diff --git a/specs/index.rst b/specs/index.rst new file mode 100644 index 0000000..6f08e74 --- /dev/null +++ b/specs/index.rst @@ -0,0 +1,9 @@ +================ + Specifications +================ + +.. toctree:: + :glob: + :maxdepth: 1 + + juno/index diff --git a/specs/juno/index.rst b/specs/juno/index.rst new file mode 100644 index 0000000..0eaf338 --- /dev/null +++ b/specs/juno/index.rst @@ -0,0 +1,11 @@ +===================== + Juno Specifications +===================== + +.. toctree:: + :glob: + :maxdepth: 2 + +.. FIXME(dhellmann): Uncomment after adding first real spec. +.. * +