change dirs to use new opnfv doc build script

Change-Id: Icfc17b1370fc111e0e9919f2f1c1d9ea8aee2702
Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

diff --git a/.gitignore b/.gitignore
index dac8212..84ba68c 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
-build/
-public/
+/build/
+/output/
+/releng/

diff --git a/Makefile b/Makefile
deleted file mode 100644 (file)
index 1e06ef3..0000000
--- a/Makefile
+++ /dev/null
@@ -1,44 +0,0 @@
-BUILDDIR := build
-PUBLICDIR := public
-DESIGN_DOCS = $(wildcard design_docs/*.rst)
-MANUALS = $(wildcard manuals/*.rst)
-
-.PHONY: clean html pdf bps man all public
-
-define index
-       rm -f $1/index.html
-       find $1 -type f | while read a; do echo "<li><a href=$${a#$1/}>$${a#$1/}</a></li>" >> $1/index.html; done
-endef
-
-all: man bps html pdf
-       $(call index,$(BUILDDIR))
-
-public:
-       rm -rf $(PUBLICDIR)
-       mkdir -p $(PUBLICDIR)
-       cp -r $(BUILDDIR)/manuals $(PUBLICDIR)/
-       cp -r $(BUILDDIR)/design_docs $(PUBLICDIR)/
-       cp -r $(BUILDDIR)/requirements/html $(PUBLICDIR)/
-       cp -r $(BUILDDIR)/requirements/latex/*.pdf $(PUBLICDIR)/
-       $(call index,$(PUBLICDIR))
-
-clean:
-       rm -rf $(BUILDDIR)/*
-
-man:
-       mkdir -p $(BUILDDIR)/manuals
-       $(foreach f,$(MANUALS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);)
-
-bps: $(DESIGN_DOCS)
-       mkdir -p $(BUILDDIR)/design_docs
-       $(foreach f,$(DESIGN_DOCS),rst2html.py $(f) $(BUILDDIR)/$(f:.rst=.html);)
-
-html:
-       sphinx-build -b html -c etc -d $(BUILDDIR)/doctrees \
-           requirements $(BUILDDIR)/requirements/html
-
-pdf:
-       sphinx-build -b latex -c etc -d $(BUILDDIR)/doctrees \
-           requirements $(BUILDDIR)/requirements/latex
-       $(MAKE) -C $(BUILDDIR)/requirements/latex \
-           LATEXOPTS='--interaction=nonstopmode' all-pdf

diff --git a/design_docs/README b/docs/design/index.rst
similarity index 73%
rename from design_docs/README
rename to docs/design/index.rst
index f0491cf..981b7af 100644 (file)
--- a/design_docs/README
+++ b/docs/design/index.rst
@@ -1,3 +1,7 @@
+****************
+Design Documents
+****************
+
 This is the directory to store design documents which may include draft
 versions of blueprints written before proposing to upstream OSS communities
 such as OpenStack, in order to keep the original blueprint as reviewed in
@@ -7,3 +11,10 @@ document to find the latest version of the blueprint and status of development
 in the relevant OSS community.
 
 See also https://wiki.opnfv.org/requirements_projects .
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   report-host-fault-to-update-server-state-immediately.rst
+   notification-alarm-evaluator.rst

diff --git a/design_docs/notification-alarm-evaluator.rst b/docs/design/notification-alarm-evaluator.rst
similarity index 100%
rename from design_docs/notification-alarm-evaluator.rst
rename to docs/design/notification-alarm-evaluator.rst

diff --git a/design_docs/report-host-fault-to-update-server-state-immediately.rst b/docs/design/report-host-fault-to-update-server-state-immediately.rst
similarity index 100%
rename from design_docs/report-host-fault-to-update-server-state-immediately.rst
rename to docs/design/report-host-fault-to-update-server-state-immediately.rst

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
deleted file mode 100644 (file)
index 0066035..0000000
--- a/docs/etc/conf.py
+++ /dev/null
@@ -1,34 +0,0 @@
-import datetime
-import sys
-import os
-
-try:
-    __import__('imp').find_module('sphinx.ext.numfig')
-    extensions = ['sphinx.ext.numfig']
-except ImportError:
-    # 'pip install sphinx_numfig'
-    extensions = ['sphinx_numfig']
-
-# numfig:
-number_figures = True
-figure_caption_prefix = "Fig."
-
-source_suffix = '.rst'
-master_doc = 'index'
-pygments_style = 'sphinx'
-html_use_index = False
-
-pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
-pdf_fit_mode = "shrink"
-pdf_stylesheets = ['sphinx','kerning','a4']
-#latex_domain_indices = False
-#latex_use_modindex = False
-
-latex_elements = {
-    'printindex': '',
-}
-
-project = u'OPNFV: Template documentation config'
-copyright = u'%s, OPNFV' % datetime.date.today().year
-version = u'1.0.0'
-release = u'1.0.0'

diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png
deleted file mode 100644 (file)
index 1519503..0000000
Binary files a/docs/etc/opnfv-logo.png and /dev/null differ

diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
deleted file mode 100644 (file)
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 (file)
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|

diff --git a/docs/manuals/index.rst b/docs/manuals/index.rst
new file mode 100644 (file)
index 0000000..b3e9e63
--- /dev/null
+++ b/docs/manuals/index.rst
@@ -0,0 +1,9 @@
+*******
+Manuals
+*******
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   mark-host-down_manual.rst

diff --git a/manuals/mark-host-down_manual.rst b/docs/manuals/mark-host-down_manual.rst
similarity index 93%
rename from manuals/mark-host-down_manual.rst
rename to docs/manuals/mark-host-down_manual.rst
index 499644f..7962dba 100644 (file)
--- a/manuals/mark-host-down_manual.rst
+++ b/docs/manuals/mark-host-down_manual.rst
@@ -1,11 +1,15 @@
+=========================================
 OpenStack NOVA API for marking host down.
+=========================================
 
 Related Blueprints:
+===================
 
   https://blueprints.launchpad.net/nova/+spec/mark-host-down
   https://blueprints.launchpad.net/python-novaclient/+spec/support-force-down-service
 
 What the API is for
+===================
 
   This API will give external fault monitoring system a possibility of telling
   OpenStack Nova fast that compute host is down. This will immediately enable
@@ -13,6 +17,7 @@ What the API is for
   actions.
 
 What this API does
+==================
 
   In OpenStack the nova-compute service state can represent the compute host
   state and this new API is used to force this service down. It is assumed
@@ -28,6 +33,7 @@ What this API does
   https://blueprints.launchpad.net/nova/+spec/robustify-evacuate
 
 REST API for forcing down:
+==========================
 
   Parameter explanations:
   tenant_id:       Identifier of the tenant.
@@ -62,6 +68,7 @@ REST API for forcing down:
   inary": "nova-compute", "host": "compute1", "forced_down": true}'
 
 CLI for forcing down:
+=====================
 
   nova service-force-down <hostname> nova-compute
 
@@ -69,6 +76,7 @@ CLI for forcing down:
   nova service-force-down compute1 nova-compute
 
 REST API for disabling forced down:
+===================================
 
   Parameter explanations:
   tenant_id:       Identifier of the tenant.
@@ -103,6 +111,8 @@ REST API for disabling forced down:
   inary": "nova-compute", "host": "compute1", "forced_down": false}'
 
 CLI for disabling forced down:
+==============================
+
   nova service-force-down --unset <hostname> nova-compute
 
   Example:

diff --git a/requirements/01-intro.rst b/docs/requirements/01-intro.rst
similarity index 100%
rename from requirements/01-intro.rst
rename to docs/requirements/01-intro.rst

diff --git a/requirements/02-use_cases.rst b/docs/requirements/02-use_cases.rst
similarity index 100%
rename from requirements/02-use_cases.rst
rename to docs/requirements/02-use_cases.rst

diff --git a/requirements/03-architecture.rst b/docs/requirements/03-architecture.rst
similarity index 100%
rename from requirements/03-architecture.rst
rename to docs/requirements/03-architecture.rst

diff --git a/requirements/04-gaps.rst b/docs/requirements/04-gaps.rst
similarity index 100%
rename from requirements/04-gaps.rst
rename to docs/requirements/04-gaps.rst

diff --git a/requirements/05-implementation.rst b/docs/requirements/05-implementation.rst
similarity index 100%
rename from requirements/05-implementation.rst
rename to docs/requirements/05-implementation.rst

diff --git a/requirements/06-summary.rst b/docs/requirements/06-summary.rst
similarity index 100%
rename from requirements/06-summary.rst
rename to docs/requirements/06-summary.rst

diff --git a/requirements/07-annex.rst b/docs/requirements/07-annex.rst
similarity index 100%
rename from requirements/07-annex.rst
rename to docs/requirements/07-annex.rst

diff --git a/requirements/99-references.rst b/docs/requirements/99-references.rst
similarity index 100%
rename from requirements/99-references.rst
rename to docs/requirements/99-references.rst

diff --git a/requirements/glossary.rst b/docs/requirements/glossary.rst
similarity index 100%
rename from requirements/glossary.rst
rename to docs/requirements/glossary.rst

diff --git a/requirements/images/figure1.png b/docs/requirements/images/figure1.png
similarity index 100%
rename from requirements/images/figure1.png
rename to docs/requirements/images/figure1.png

diff --git a/requirements/images/figure10.png b/docs/requirements/images/figure10.png
similarity index 100%
rename from requirements/images/figure10.png
rename to docs/requirements/images/figure10.png

diff --git a/requirements/images/figure11.png b/docs/requirements/images/figure11.png
similarity index 100%
rename from requirements/images/figure11.png
rename to docs/requirements/images/figure11.png

diff --git a/requirements/images/figure12.png b/docs/requirements/images/figure12.png
similarity index 100%
rename from requirements/images/figure12.png
rename to docs/requirements/images/figure12.png

diff --git a/requirements/images/figure13.png b/docs/requirements/images/figure13.png
similarity index 100%
rename from requirements/images/figure13.png
rename to docs/requirements/images/figure13.png

diff --git a/requirements/images/figure14.png b/docs/requirements/images/figure14.png
similarity index 100%
rename from requirements/images/figure14.png
rename to docs/requirements/images/figure14.png

diff --git a/requirements/images/figure2.png b/docs/requirements/images/figure2.png
similarity index 100%
rename from requirements/images/figure2.png
rename to docs/requirements/images/figure2.png

diff --git a/requirements/images/figure3.png b/docs/requirements/images/figure3.png
similarity index 100%
rename from requirements/images/figure3.png
rename to docs/requirements/images/figure3.png

diff --git a/requirements/images/figure4.png b/docs/requirements/images/figure4.png
similarity index 100%
rename from requirements/images/figure4.png
rename to docs/requirements/images/figure4.png

diff --git a/requirements/images/figure5.png b/docs/requirements/images/figure5.png
similarity index 100%
rename from requirements/images/figure5.png
rename to docs/requirements/images/figure5.png

diff --git a/requirements/images/figure6.png b/docs/requirements/images/figure6.png
similarity index 100%
rename from requirements/images/figure6.png
rename to docs/requirements/images/figure6.png

diff --git a/requirements/images/figure7.png b/docs/requirements/images/figure7.png
similarity index 100%
rename from requirements/images/figure7.png
rename to docs/requirements/images/figure7.png

diff --git a/requirements/images/figure8.png b/docs/requirements/images/figure8.png
similarity index 100%
rename from requirements/images/figure8.png
rename to docs/requirements/images/figure8.png

diff --git a/requirements/images/figure9.png b/docs/requirements/images/figure9.png
similarity index 100%
rename from requirements/images/figure9.png
rename to docs/requirements/images/figure9.png

diff --git a/requirements/index.rst b/docs/requirements/index.rst
similarity index 90%
rename from requirements/index.rst
rename to docs/requirements/index.rst
index 61046c3..ae5f2a3 100644 (file)
--- a/requirements/index.rst
+++ b/docs/requirements/index.rst
@@ -1,12 +1,3 @@
-..
- This work is licensed under a Creative Commons Attribution 3.0 Unported
- License.
-
- http://creativecommons.org/licenses/by/3.0/legalcode
-
-.. title::
-    Doctor
-
 ****************************************
 Doctor: Fault Management and Maintenance
 ****************************************
@@ -41,7 +32,6 @@ Doctor: Fault Management and Maintenance
           18.05.2015 Stable version of the Doctor deliverable
           ========== =====================================================
 
-
 .. raw:: latex
 
     \newpage
@@ -63,7 +53,3 @@ Doctor: Fault Management and Maintenance
 
 .. include::
     99-references.rst
-
-
-..
- vim: set tabstop=4 expandtab textwidth=80:

diff --git a/etc/conf.py b/etc/conf.py
deleted file mode 100644 (file)
index 05dbc4d..0000000
--- a/etc/conf.py
+++ /dev/null
@@ -1,27 +0,0 @@
-import datetime
-import sys
-import os
-
-needs_sphinx = '1.3'
-
-numfig = True
-
-source_suffix = '.rst'
-master_doc = 'index'
-pygments_style = 'sphinx'
-html_use_index = False
-
-pdf_documents = [('index', u'Doctor', u'Doctor Project', u'OPNFV')]
-pdf_fit_mode = "shrink"
-pdf_stylesheets = ['sphinx','kerning','a4']
-#latex_domain_indices = False
-#latex_use_modindex = False
-
-latex_elements = {
-    'printindex': '',
-}
-
-project = u'Doctor: Fault Management and Maintenance'
-copyright = u'%s, OPNFV' % datetime.date.today().year
-version = u'1.0.0'
-release = u'1.0.0'