Fix Functest Internship Reports

It allows building these documentations via tox.
rst files are now checked via doc8.

Change-Id: I06096d466b672e4c171240c918d1c91e1b3dfd13
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

2 files changed, 226 insertions, 51 deletions

diff --git a/docs/testing/developer/internship/vnf_catalog/conf.py b/docs/testing/developer/internship/vnf_catalog/conf.py
new file mode 100644
index 000000000..4bc609810
--- /dev/null
+++ b/docs/testing/developer/internship/vnf_catalog/conf.py
@@ -0,0 +1,185 @@
+# -*- coding: utf-8 -*-
+#
+# Open Source VNF Catalog documentation build configuration file, created by
+# sphinx-quickstart on Wed Apr  4 06:07:56 2018.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+import sphinx_opnfv_theme
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = []
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Open Source VNF Catalog'
+copyright = u'2018, Cédric Ollivier <cedric.ollivier@orange.com>'
+author = u'Cédric Ollivier <cedric.ollivier@orange.com>'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'master'
+# The full version, including alpha/beta/rc tags.
+release = u'master'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'opnfv'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+html_theme_options = {
+    'bootswatch_theme': 'journal',
+    'navbar_sidebarrel': False,
+    'navbar_title': '',
+}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = []
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenSourceVNFCatalogdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc,
+     'OpenSourceVNFCatalog.tex',
+     u'Open Source VNF Catalog Documentation',
+     u'Cédric Ollivier \\textless{}cedric.ollivier@orange.com\\textgreater{}',
+     'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc,
+     'opensourcevnfcatalog',
+     u'Open Source VNF Catalog Documentation',
+     [author],
+     1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc,
+     'OpenSourceVNFCatalog',
+     u'Open Source VNF Catalog Documentation',
+     author,
+     'OpenSourceVNFCatalog',
+     'One line description of project.',
+     'Miscellaneous'),
+]
diff --git a/docs/testing/developer/internship/vnf_catalog/index.rst b/docs/testing/developer/internship/vnf_catalog/index.rst
index df7633391..634b728bd 100644
--- a/docs/testing/developer/internship/vnf_catalog/index.rst
+++ b/docs/testing/developer/internship/vnf_catalog/index.rst
@@ -1,11 +1,4 @@
-=======
-License
-=======
-
-Functest Docs are licensed under a Creative Commons Attribution 4.0
-International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
+.. SPDX-License-Identifier: CC-BY-4.0
 
 =======================
 Open Source VNF Catalog
@@ -68,57 +61,54 @@ Curation Phase
 This phase pertains to studying various Open Source VNFs available and
 classification of them based on certain parameters. The parameters that
 I currently have in mind are:
+
  * Developer Metrics: These pertain to repo characteristics of VNF under
- study
-  * Usage Statistics - Activity, Number of Commits, stars
-  * Maturity Statistics - For instance if an NFV community decides code
-  coverage is important for them, it shows the NFV community is serious
-  about taking the project forward
+   study
+ * Usage Statistics - Activity, Number of Commits, stars
+ * Maturity Statistics - For instance if an NFV community decides code
+   coverage is important for them, it shows the NFV community is serious
+   about taking the project forward
  * Technical Tagging: These are the tags that pertain to technical
- characteristics of a VNF
-  * Broad Use Cases - Whether the VNF fits strictly in IaaS, PaaS or
-  SaaS layer or is an hybrid of two/all.
-  * Generic Use Cases - This in my opinion is the broadest
-  classification category. For instance a VNF could be built with a
-  broad idea of powering IOT devices at home or from usage perspective
-  of Telco Operators (vFW, vEPC, vIMS, vCDN, vAAA, vCPE,...).`[2]`_
-  * Fields of Application
-  * Library Status - Whether APIs are standardized, support RESTful
-  services.
-  * Dependency Forwarding Graph - This is pretty complex tagging
-  mechanism. It essentially tries to establish a graph relationship
-  between the VNFs (elementary VNFs are used in Service Function
-  Chaining chains such as Firewall, DPI, content enrichment,..). In my
-  opinion this is useful immensely. This will allow users to go to
-  platform and ask a question like - “I have this X tech stack to
-  support, Y and Z are my use cases, which NFVs should I use to support
-  this.
-  * Visitor Score - Based on `[1]`_ I plan to evolve a visitor score for
-  the platform. This will allow users to score an NFV on certain
-  parameters, may be post comments.
+   characteristics of a VNF
+ * Broad Use Cases - Whether the VNF fits strictly in IaaS, PaaS or
+   SaaS layer or is an hybrid of two/all.
+ * Generic Use Cases - This in my opinion is the broadest
+   classification category. For instance a VNF could be built with a
+   broad idea of powering IOT devices at home or from usage perspective
+   of Telco Operators (vFW, vEPC, vIMS, vCDN, vAAA, vCPE,...).`[2]`_
+ * Fields of Application
+ * Library Status - Whether APIs are standardized, support RESTful
+   services.
+ * Dependency Forwarding Graph - This is pretty complex tagging
+   mechanism. It essentially tries to establish a graph relationship
+   between the VNFs (elementary VNFs are used in Service Function
+   Chaining chains such as Firewall, DPI, content enrichment,..). In my
+   opinion this is useful immensely. This will allow users to go to
+   platform and ask a question like - “I have this X tech stack to
+   support, Y and Z are my use cases, which NFVs should I use to support
+   this.
+ * Visitor Score - Based on `[1]`_ I plan to evolve a visitor score for
+   the platform. This will allow users to score an NFV on certain
+   parameters, may be post comments.
 
 **I plan to use the above three scores and evolve cumulative score which
 will be displayed next to each of the NFV on the platform.**
 
  * Platform building phase - This will involve erecting a Web Platform
- which will be similar to this  `[1]`_. I am decently familiar with
- Django and hence I will write the platform in Django. There are two
- action plans that I have in mind right now. Either I can start writing
- the platform simultaneously which will help keep track of my progress
- or I can write the platform after 1.5 - 2 months into the internship.
- Either way I aim to have the Web Platform ready by March 12.
-
+   which will be similar to this  `[1]`_. I am decently familiar with
+   Django and hence I will write the platform in Django. There are two
+   action plans that I have in mind right now. Either I can start writing
+   the platform simultaneously which will help keep track of my progress
+   or I can write the platform after 1.5 - 2 months into the internship.
+   Either way I aim to have the Web Platform ready by March 12.
  * Functest VNF implementation phase - This is the last phase that will
- involve writing a fully functional implementation of an Open Source VNF
- into Functest. I will undertake this after I am 3 months into the
- internship. I have a decent familiarity with python and hence I think
- it shouldn’t be too difficult. I need to decide how complex the VNFI
- should undertake this exercise for (e.g. AAA such as free radius sounds
- relatively easy, vCDN is much more challenging).
- This will be decided in consent with my mentors.
-
-
-
+   involve writing a fully functional implementation of an Open Source VNF
+   into Functest. I will undertake this after I am 3 months into the
+   internship. I have a decent familiarity with python and hence I think
+   it shouldn’t be too difficult. I need to decide how complex the VNFI
+   should undertake this exercise for (e.g. AAA such as free radius sounds
+   relatively easy, vCDN is much more challenging).
+   This will be decided in consent with my mentors.
 
 Schedule:
 =========