diff options
-rw-r--r-- | Makefile | 24 | ||||
-rwxr-xr-x | etc/conf.py | 41 | ||||
-rw-r--r-- | requirements/01-intro.rst (renamed from requirements/resource_management/01-intro.rst) | 0 | ||||
-rw-r--r-- | requirements/02-usecase.rst (renamed from requirements/resource_management/02-usecase.rst) | 0 | ||||
-rwxr-xr-x | requirements/03-arch.rst (renamed from requirements/resource_management/03-arch.rst) | 0 | ||||
-rw-r--r-- | requirements/04-gap.rst (renamed from requirements/resource_management/04-gap.rst) | 0 | ||||
-rwxr-xr-x | requirements/05-impl.rst (renamed from requirements/resource_management/05-impl.rst) | 0 | ||||
-rw-r--r-- | requirements/06-summary.rst (renamed from requirements/resource_management/06-summary.rst) | 0 | ||||
-rw-r--r-- | requirements/07-schemas.rst (renamed from requirements/resource_management/07-schemas.rst) | 0 | ||||
-rw-r--r-- | requirements/glossary.rst (renamed from requirements/resource_management/glossary.rst) | 0 | ||||
-rwxr-xr-x | requirements/images/figure1.png (renamed from requirements/resource_management/images/figure1.png) | bin | 60391 -> 60391 bytes | |||
-rwxr-xr-x | requirements/images/figure2.png (renamed from requirements/resource_management/images/figure2.png) | bin | 149390 -> 149390 bytes | |||
-rwxr-xr-x | requirements/images/figure3.png (renamed from requirements/resource_management/images/figure3.png) | bin | 38065 -> 38065 bytes | |||
-rwxr-xr-x | requirements/images/figure4.png (renamed from requirements/resource_management/images/figure4.png) | bin | 218419 -> 218419 bytes | |||
-rwxr-xr-x | requirements/images/figure5.png (renamed from requirements/resource_management/images/figure5.png) | bin | 38402 -> 38402 bytes | |||
-rwxr-xr-x | requirements/images/figure6.png (renamed from requirements/resource_management/images/figure6.png) | bin | 401171 -> 401171 bytes | |||
-rw-r--r-- | requirements/index.rst (renamed from requirements/resource_management/index.rst) | 0 | ||||
-rw-r--r-- | requirements/resource_management/Makefile | 18 | ||||
-rwxr-xr-x | requirements/resource_management/conf.py | 21 |
19 files changed, 65 insertions, 39 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..7d4dd23 --- /dev/null +++ b/Makefile @@ -0,0 +1,24 @@ +BUILDDIR := build + +.PHONY: clean html pdf default + +default: pdf + +clean: + rm -rf $(BUILDDIR) plantuml.jar + +html: plantuml.jar | $(BUILDDIR) + sphinx-build -b html -c etc -d $(BUILDDIR)/doctrees \ + requirements $(BUILDDIR)/requirements/html + +pdf: plantuml.jar | $(BUILDDIR) + sphinx-build -b latex -c etc -d $(BUILDDIR)/doctrees \ + requirements $(BUILDDIR)/requirements/latex + $(MAKE) -C $(BUILDDIR)/requirements/latex \ + LATEXOPTS='--interaction=nonstopmode' all-pdf + +$(BUILDDIR): + mkdir -p $(BUILDDIR) + +plantuml.jar: + wget 'http://downloads.sourceforge.net/project/plantuml/plantuml.jar' diff --git a/etc/conf.py b/etc/conf.py new file mode 100755 index 0000000..e24d33a --- /dev/null +++ b/etc/conf.py @@ -0,0 +1,41 @@ +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'] + +# plantuml +extensions.append('sphinxcontrib.plantuml') +plantuml = ['java', '-jar', 'plantuml.jar'] + +# 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'Promise', u'Promise 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'Promise: Resource Management' +copyright = u'%s, OPNFV' % datetime.date.today().year +version = u'1.0.0' +release = u'1.0.0' + +# TODO(r-mibu): remove the following line to index.rst +latex_appendices = ['07-schemas'] diff --git a/requirements/resource_management/01-intro.rst b/requirements/01-intro.rst index fdceaf1..fdceaf1 100644 --- a/requirements/resource_management/01-intro.rst +++ b/requirements/01-intro.rst diff --git a/requirements/resource_management/02-usecase.rst b/requirements/02-usecase.rst index b1a1cfa..b1a1cfa 100644 --- a/requirements/resource_management/02-usecase.rst +++ b/requirements/02-usecase.rst diff --git a/requirements/resource_management/03-arch.rst b/requirements/03-arch.rst index 23bbac7..23bbac7 100755 --- a/requirements/resource_management/03-arch.rst +++ b/requirements/03-arch.rst diff --git a/requirements/resource_management/04-gap.rst b/requirements/04-gap.rst index 908f27f..908f27f 100644 --- a/requirements/resource_management/04-gap.rst +++ b/requirements/04-gap.rst diff --git a/requirements/resource_management/05-impl.rst b/requirements/05-impl.rst index 7bbaa0c..7bbaa0c 100755 --- a/requirements/resource_management/05-impl.rst +++ b/requirements/05-impl.rst diff --git a/requirements/resource_management/06-summary.rst b/requirements/06-summary.rst index 381ab87..381ab87 100644 --- a/requirements/resource_management/06-summary.rst +++ b/requirements/06-summary.rst diff --git a/requirements/resource_management/07-schemas.rst b/requirements/07-schemas.rst index 3887cc7..3887cc7 100644 --- a/requirements/resource_management/07-schemas.rst +++ b/requirements/07-schemas.rst diff --git a/requirements/resource_management/glossary.rst b/requirements/glossary.rst index c1997f2..c1997f2 100644 --- a/requirements/resource_management/glossary.rst +++ b/requirements/glossary.rst diff --git a/requirements/resource_management/images/figure1.png b/requirements/images/figure1.png Binary files differindex ef78c00..ef78c00 100755 --- a/requirements/resource_management/images/figure1.png +++ b/requirements/images/figure1.png diff --git a/requirements/resource_management/images/figure2.png b/requirements/images/figure2.png Binary files differindex dd002a2..dd002a2 100755 --- a/requirements/resource_management/images/figure2.png +++ b/requirements/images/figure2.png diff --git a/requirements/resource_management/images/figure3.png b/requirements/images/figure3.png Binary files differindex 20e51c7..20e51c7 100755 --- a/requirements/resource_management/images/figure3.png +++ b/requirements/images/figure3.png diff --git a/requirements/resource_management/images/figure4.png b/requirements/images/figure4.png Binary files differindex e0c96a1..e0c96a1 100755 --- a/requirements/resource_management/images/figure4.png +++ b/requirements/images/figure4.png diff --git a/requirements/resource_management/images/figure5.png b/requirements/images/figure5.png Binary files differindex 4e161f4..4e161f4 100755 --- a/requirements/resource_management/images/figure5.png +++ b/requirements/images/figure5.png diff --git a/requirements/resource_management/images/figure6.png b/requirements/images/figure6.png Binary files differindex 8aeec23..8aeec23 100755 --- a/requirements/resource_management/images/figure6.png +++ b/requirements/images/figure6.png diff --git a/requirements/resource_management/index.rst b/requirements/index.rst index 855bd28..855bd28 100644 --- a/requirements/resource_management/index.rst +++ b/requirements/index.rst diff --git a/requirements/resource_management/Makefile b/requirements/resource_management/Makefile deleted file mode 100644 index dbf00e2..0000000 --- a/requirements/resource_management/Makefile +++ /dev/null @@ -1,18 +0,0 @@ -BUILDDIR = build - -.PHONY: clean html pdf all - -all: html pdf - -clean: - rm -rf $(BUILDDIR)/* plantuml.jar - -html: plantuml.jar - sphinx-build -b html -d $(BUILDDIR)/doctrees . $(BUILDDIR)/html - -pdf: plantuml.jar - sphinx-build -b latex -d $(BUILDDIR)/doctrees . $(BUILDDIR)/latex - $(MAKE) -C $(BUILDDIR)/latex all-pdf - -plantuml.jar: - wget 'http://downloads.sourceforge.net/project/plantuml/plantuml.jar' diff --git a/requirements/resource_management/conf.py b/requirements/resource_management/conf.py deleted file mode 100755 index 93c3e16..0000000 --- a/requirements/resource_management/conf.py +++ /dev/null @@ -1,21 +0,0 @@ -import datetime - -extensions = ['sphinxcontrib.plantuml'] -plantuml = ['java', '-jar', 'plantuml.jar'] - -source_suffix = '.rst' -master_doc = 'index' -pygments_style = 'sphinx' -html_use_index = False - -pdf_documents = [('index', u'Promise', u'Promise Project', u'OPNFV')] -plantuml_latex_output_format = 'eps' -pdf_fit_mode = "shrink" -pdf_stylesheets = ['sphinx','kerning','a4'] -latex_elements = {'printindex': ''} -latex_appendices = ['07-schemas'] - -project = u'Promise: Resource Management' -copyright = u'%s, OPNFV' % datetime.date.today().year -version = u'0.0.1' -release = u'0.0.1' |