Move design_docs into docs/design

Change HTML theme for sphinx
Fix makefile reference to old design_docs dir

Change-Id: I848115c5901db8dc33aa4157bdbc8af430695f31
Signed-off-by: blsaws <blsaws@hotmail.com>

12 files changed, 6 insertions, 119 deletions

diff --git a/Makefile b/Makefile
index 8b2eba7..8a2612d 100644
--- a/Makefile
+++ b/Makefile
@@ -1,5 +1,5 @@
 BUILDDIR := build
-DESIGN_DOCS = $(wildcard design_docs/*.rst)
+DESIGN_DOCS = $(wildcard docs/design/*.rst)
 
 .PHONY: clean html pdf bps all
 
@@ -9,11 +9,11 @@ clean:
 	rm -rf $(BUILDDIR)/*
 
 bps: $(DESIGN_DOCS) | $(BUILDDIR)
-	mkdir -p $(BUILDDIR)/design_docs
+	mkdir -p $(BUILDDIR)/docs/design
 	$(foreach f,$(DESIGN_DOCS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);)
 
 bps: $(DESIGN_DOCS) | $(BUILDDIR)
-	mkdir -p $(BUILDDIR)/design_docs
+	mkdir -p $(BUILDDIR)/docs/design
 	$(foreach f,$(DESIGN_DOCS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.pdf);)
 
 $(BUILDDIR):
diff --git a/design_docs/architecture.rst b/docs/design/architecture.rst
index 9949c1a..9949c1a 100644
--- a/design_docs/architecture.rst
+++ b/docs/design/architecture.rst
diff --git a/design_docs/definitions.rst b/docs/design/definitions.rst
index 4423d45..4423d45 100644
--- a/design_docs/definitions.rst
+++ b/docs/design/definitions.rst
diff --git a/design_docs/images/policy_architecture.png b/docs/design/images/policy_architecture.png
index eb37e36..eb37e36 100644
--- a/design_docs/images/policy_architecture.png
+++ b/docs/design/images/policy_architecture.png
diff --git a/design_docs/images/policy_architecture.pptx b/docs/design/images/policy_architecture.pptx
index 5739f0f..5739f0f 100644
--- a/design_docs/images/policy_architecture.pptx
+++ b/docs/design/images/policy_architecture.pptx
diff --git a/design_docs/index.rst b/docs/design/index.rst
index 1f251a8..1f251a8 100644
--- a/design_docs/index.rst
+++ b/docs/design/index.rst
diff --git a/design_docs/introduction.rst b/docs/design/introduction.rst
index b9d9722..b9d9722 100644
--- a/design_docs/introduction.rst
+++ b/docs/design/introduction.rst
diff --git a/design_docs/requirements.rst b/docs/design/requirements.rst
index ee88b3c..ee88b3c 100644
--- a/design_docs/requirements.rst
+++ b/docs/design/requirements.rst
diff --git a/design_docs/usecases.rst b/docs/design/usecases.rst
index c4e6abd..046cfe2 100644
--- a/design_docs/usecases.rst
+++ b/docs/design/usecases.rst
@@ -154,6 +154,8 @@ As a service provider or tenant, I need to be informed of VMs that are under-uti
 
 As implemented through OpenStack Congress: 
 
+*Note: untested example...*
+
 .. code:: 
 
   reclaim_server(vm) :-
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 0066035..cff2d96 100644
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -17,6 +17,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 pygments_style = 'sphinx'
 html_use_index = False
+html_theme = 'sphinx_rtd_theme'
 
 pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
 pdf_fit_mode = "shrink"
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
deleted file mode 100644
index afcf758..0000000
--- a/docs/how-to-use-docs/documentation-example.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-.. two dots create a comment. please leave this logo at the top of each of your rst files.
-.. image:: ../etc/opnfv-logo.png 
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-.. these two pipes are to seperate the logo from the first title
-|
-|
-How to create documentation for your OPNFV project
-==================================================
-
-this is the directory structure of the docs/ directory that can be found in the root of your project directory
-
-.. code-block:: bash
-
-    ./etc
-    ./etc/opnfv-logo.png
-    ./etc/conf.py
-    ./how-to-use-docs
-    ./how-to-use-docs/documentation-example.rst
-    ./how-to-use-docs/index.rst
-
-To create your own documentation, Create any number of directories (depending on your need) and place in each of them an index.rst.
-This index file must refence your other rst files.
-
-* Here is an example index.rst
-
-.. code-block:: bash
-
-  Example Documentation table of contents
-  =======================================
-
-  Contents:
-
-  .. toctree::
-     :numbered:
-     :maxdepth: 4
-
-     documentation-example.rst
-
-  Indices and tables
-  ==================
-
-  * :ref:`search`
-
-  Revision: _sha1_
-
-  Build date: |today|
-
-
-The Sphinx Build
-================
-
-When you push documentation changes to gerrit a jenkins job will create html documentation.
-
-* Verify Jobs
-For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
-
-* Merge jobs
-
-Once you are happy with the look of your documentation you can submit the patchset the merge job will 
-copy the output of each documentation directory to http://artifacts.opnfv.org/$project/docs/$name_of_your_folder/index.html
-
-Here are some quick examples of how to use rst markup
-
-This is a headline::
-
-  here is some code, note that it is indented
-
-links are easy to add: Here is a link to sphinx, the tool that we are using to generate documetation http://sphinx-doc.org/
-
-* Bulleted Items
-
-  **this will be bold**
-
-.. code-block:: bash
-
-  echo "Heres is a code block with bash syntax highlighting"
-
-
-Leave these at the bottom of each of your documents they are used internally
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/how-to-use-docs/index.rst b/docs/how-to-use-docs/index.rst
deleted file mode 100644
index 36710b3..0000000
--- a/docs/how-to-use-docs/index.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
-Example Documentation table of contents
-=======================================
-
-Contents:
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   documentation-example.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|