Merge "Updated scenario documentation"

diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst
index 18a6ea2..bde1633 100644 (file)
--- a/docs/featureprojects.rst
+++ b/docs/featureprojects.rst
@@ -78,20 +78,6 @@ Compass4Nfv
    ../submodules/compass4nfv/docs/development/manuals/index
 
 
-Copper
-------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/copper/docs/development/overview/index
-   ../submodules/copper/docs/development/requirements/index
-   ../submodules/copper/docs/release/installation/index
-   ../submodules/copper/docs/release/configguide/index
-   ../submodules/copper/docs/release/userguide/index
-   ../submodules/copper/docs/development/design/index
-   ../submodules/copper/docs/development/manuals/index
-
-
 Daisy4NFV
 ---------
 .. toctree::
@@ -116,20 +102,6 @@ Doctor
    ../submodules/doctor/docs/development/manuals/index
 
 
-Domino
-------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/domino/docs/development/overview/index
-   ../submodules/domino/docs/development/requirements/index
-   ../submodules/domino/docs/release/installation/index
-   ../submodules/domino/docs/release/configguide/index
-   ../submodules/domino/docs/release/userguide/index
-   ../submodules/domino/docs/development/design/index
-   ../submodules/domino/docs/development/manuals/index
-
-
 IPV6
 ----
 .. toctree::
@@ -158,48 +130,6 @@ Joid
    ../submodules/joid/docs/development/manuals/index
 
 
-Kvmfornfv
----------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/kvmfornfv/docs/development/overview/index
-   ../submodules/kvmfornfv/docs/development/requirements/index
-   ../submodules/kvmfornfv/docs/release/installation/index
-   ../submodules/kvmfornfv/docs/release/configguide/index
-   ../submodules/kvmfornfv/docs/release/userguide/index
-   ../submodules/kvmfornfv/docs/development/design/index
-   ../submodules/kvmfornfv/docs/development/manuals/index
-
-
-Multisite
----------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/multisite/docs/development/overview/index
-   ../submodules/multisite/docs/development/requirements/index
-   ../submodules/multisite/docs/release/installation/index
-   ../submodules/multisite/docs/release/configguide/index
-   ../submodules/multisite/docs/release/userguide/index
-   ../submodules/multisite/docs/development/design/index
-   ../submodules/multisite/docs/development/manuals/index
-
-
-Netready
---------
-.. toctree::
-   :maxdepth: 1
-
-   ../submodules/netready/docs/development/overview/index
-   ../submodules/netready/docs/development/requirements/index
-   ../submodules/netready/docs/release/installation/index
-   ../submodules/netready/docs/release/configguide/index
-   ../submodules/netready/docs/release/userguide/index
-   ../submodules/netready/docs/development/design/index
-   ../submodules/netready/docs/development/manuals/index
-
-
 Opera
 -----
 .. toctree::

diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 8aad8a4..ade660c 100644 (file)
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -38,20 +38,12 @@ Project release notes:
 
 :ref:`Joid Release Notes <joid-releasenotes>`
 
-:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>`
-
-:ref:`Moon Release Notes <moon-releasenotes>`
-
-:ref:`Netready Release Notes <netready-releasenotes>`
-
 :ref:`NFVBench Release Notes <nfvbench-releasenotes>`
 
 :ref:`Orchestra Release Notes <orchestra-releasenotes>`
 
 :ref:`Parser Release Notes <parser-releasenotes>`
 
-:ref:`Promise Release Notes <promise-releasenotes>`
-
 :ref:`QTIP Release Notes <qtip-releasenotes>`
 
 :ref:`SampleVNF Release Notes <samplevnf-releasenotes>`

diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 3b747e6..337bf67 100644 (file)
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -61,15 +61,10 @@ Feature Configuration Guides
 - :ref:`Auto Configuration Guide <auto-configguide>`
 - :ref:`Barometer Configuration Guide <barometer-configguide>`
 - :ref:`Doctor Configuration Guide <doctor-configguide>`
-- :ref:`Domino Configuration Guide <domino-configguide>`
 - :ref:`IPv6 Configuration Guide <ipv6-configguide>`
-- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>`
-- :ref:`Moon Configuration Guide <moon-configguide>`
 - :ref:`Netready Configuration Guide <netready-configguide>`
-- :ref:`ONOSFW Configuration Guide <onosfw-configguide>`
 - :ref:`Orchestra Configuration Guide <orchestra-configguide>`
 - :ref:`Parser Configuration Guide <parser-configguide>`
-- :ref:`Promise Configuration Guide <promise-configguide>`
 - :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>`
 - :ref:`SFC Configuration Guide <sfc-configguide>`
 
@@ -80,13 +75,10 @@ Feature User Guides
 - :ref:`Auto User Guide <auto-userguide>`
 - :ref:`Barometer User Guide <barometer-userguide>`
 - :ref:`Doctor User Guide <doctor-userguide>`
-- :ref:`Domino User Guide <domino-userguide>`
 - :ref:`IPv6 User Guide <ipv6-userguide>`
-- :ref:`KVMforNFV User Guide <kvmfornfv-userguide>`
 - :ref:`OpenContrail Virtual Networking User Guide <ovno-userguide>`
 - :ref:`Orchestra User Guide <orchestra-userguide>`
 - :ref:`Parser User Guide <parser-userguide>`
-- :ref:`Promise User Guide <promise-userguide>`
 - :ref:`SDNVPN User Guide <sdnvpn-userguide>`
 - :ref:`SFC User Guide <sfc-userguide>`
 

diff --git a/docs/submodules/apex b/docs/submodules/apex
index 1abb8ac..94ce44f 160000 (submodule)
--- a/docs/submodules/apex
+++ b/docs/submodules/apex
@@ -1 +1 @@
-Subproject commit 1abb8ac25c48d182bc267d23f618043fbd7e0843
+Subproject commit 94ce44fe6e3450a1217ec3838a43049e53da9f6e

diff --git a/docs/submodules/armband b/docs/submodules/armband
index 0d7a183..6657baa 160000 (submodule)
--- a/docs/submodules/armband
+++ b/docs/submodules/armband
@@ -1 +1 @@
-Subproject commit 0d7a1834aea3bde3e27892919ae731b5cdae5560
+Subproject commit 6657baa68d238e1cba9e1d69118616e438b07f37

diff --git a/docs/submodules/auto b/docs/submodules/auto
index 40e5d1e..a85a336 160000 (submodule)
--- a/docs/submodules/auto
+++ b/docs/submodules/auto
@@ -1 +1 @@
-Subproject commit 40e5d1ef5e5c389609ab145441375cd0a17af07a
+Subproject commit a85a3366e4ca2094facf69b696e0c03e97ab45dc

diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
index 73bd5d3..61aafcb 160000 (submodule)
--- a/docs/submodules/bottlenecks
+++ b/docs/submodules/bottlenecks
@@ -1 +1 @@
-Subproject commit 73bd5d30fb9d5ee3bc01d78b431282332a53b44d
+Subproject commit 61aafcb0ca6cab9c25d2df7d409f4fa8716ebe5f

diff --git a/docs/submodules/clover b/docs/submodules/clover
index 867c430..4be1d24 160000 (submodule)
--- a/docs/submodules/clover
+++ b/docs/submodules/clover
@@ -1 +1 @@
-Subproject commit 867c4309a10df56eeb5098a78956e5d6951b8ba4
+Subproject commit 4be1d24ba88619d677f2a616239da6fa29bdb78f

diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
index 3ede18e..d7156c0 160000 (submodule)
--- a/docs/submodules/compass4nfv
+++ b/docs/submodules/compass4nfv
@@ -1 +1 @@
-Subproject commit 3ede18e758c77b31e56ca9164dbeb8e06b0223b5
+Subproject commit d7156c0b772ada65ff3d094bd70814bf5b0cb4e7

diff --git a/docs/submodules/daisy b/docs/submodules/daisy
index 6a7ee18..afb9b05 160000 (submodule)
--- a/docs/submodules/daisy
+++ b/docs/submodules/daisy
@@ -1 +1 @@
-Subproject commit 6a7ee18538561c772b0bfbc48805e2a2de74a9c6
+Subproject commit afb9b05fc088fdb60168a2dd25dda90b5d3ab2d3

diff --git a/docs/submodules/doctor b/docs/submodules/doctor
index f06386c..aeb2ff1 160000 (submodule)
--- a/docs/submodules/doctor
+++ b/docs/submodules/doctor
@@ -1 +1 @@
-Subproject commit f06386c6b436a0adce7b96c6a1d59b5d02ed31fb
+Subproject commit aeb2ff16a530c7c7af9a6e2d16ba5421dd074cff

diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail
index 749946d..cb02bcc 160000 (submodule)
--- a/docs/submodules/dovetail
+++ b/docs/submodules/dovetail
@@ -1 +1 @@
-Subproject commit 749946dcc5b17cfca43c6e8692359f4972e48b21
+Subproject commit cb02bccdef30575bb46080475ca13fdf8b6b4b2f

diff --git a/docs/submodules/fuel b/docs/submodules/fuel
index 2d2f599..9e9393a 160000 (submodule)
--- a/docs/submodules/fuel
+++ b/docs/submodules/fuel
@@ -1 +1 @@
-Subproject commit 2d2f59907d578d266e1aa19040314dc15b27c0c6
+Subproject commit 9e9393ab60ff513f01b9ce045245e6c5808590a8

diff --git a/docs/submodules/functest b/docs/submodules/functest
index b5a9b04..454a3e3 160000 (submodule)
--- a/docs/submodules/functest
+++ b/docs/submodules/functest
@@ -1 +1 @@
-Subproject commit b5a9b04871868633f5c92005b7665bfb76ee6eec
+Subproject commit 454a3e3152d90ea0f64fc64ccabc1e305f1c2f9d

diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6
index dfcc074..a1f0778 160000 (submodule)
--- a/docs/submodules/ipv6
+++ b/docs/submodules/ipv6
@@ -1 +1 @@
-Subproject commit dfcc0745ef76e684593c8284f9dcb81cca2f7959
+Subproject commit a1f0778b5aa40e2d179d00b941853749b58ab6a7

diff --git a/docs/submodules/joid b/docs/submodules/joid
index c0bc95b..6345ba5 160000 (submodule)
--- a/docs/submodules/joid
+++ b/docs/submodules/joid
@@ -1 +1 @@
-Subproject commit c0bc95b384aa0e5a398aa35a300081919898d1da
+Subproject commit 6345ba5917f720c00b165530916436578bd4c327

diff --git a/docs/submodules/moon b/docs/submodules/moon
index e93c1de..c975e6c 160000 (submodule)
--- a/docs/submodules/moon
+++ b/docs/submodules/moon
@@ -1 +1 @@
-Subproject commit e93c1de651a76f06ef0a3f247db4be5a40860139
+Subproject commit c975e6c2fcb7afadecf0371c30073791599c8c81

diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
index e456fff..eff9ff9 160000 (submodule)
--- a/docs/submodules/nfvbench
+++ b/docs/submodules/nfvbench
@@ -1 +1 @@
-Subproject commit e456fff7801702f1cf672d9ebda54eabd5100ece
+Subproject commit eff9ff971acf5c7208ab2b824b897d3183c36f3c

diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv
index 9623c07..114315d 160000 (submodule)
--- a/docs/submodules/ovn4nfv
+++ b/docs/submodules/ovn4nfv
@@ -1 +1 @@
-Subproject commit 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88d
+Subproject commit 114315d2972dc3cfa9c2d4f3508e2d23d3e4aabf

diff --git a/docs/submodules/pharos b/docs/submodules/pharos
index a3c0456..68dc60c 160000 (submodule)
--- a/docs/submodules/pharos
+++ b/docs/submodules/pharos
@@ -1 +1 @@
-Subproject commit a3c0456cc14a75e96808505e670d0cab37b30abc
+Subproject commit 68dc60c1aa7199279995c1fee59ad151b5012af9

diff --git a/docs/submodules/qtip b/docs/submodules/qtip
index 879963d..c934821 160000 (submodule)
--- a/docs/submodules/qtip
+++ b/docs/submodules/qtip
@@ -1 +1 @@
-Subproject commit 879963d90e74a4fd003bb73e8d4e50e51679f923
+Subproject commit c934821173ff9adb5608d4df2418ac23fa0b8251

diff --git a/docs/submodules/releng b/docs/submodules/releng
index 48f926a..63b16b6 160000 (submodule)
--- a/docs/submodules/releng
+++ b/docs/submodules/releng
@@ -1 +1 @@
-Subproject commit 48f926a22e0b180ffe4815e333e92e181e3d0dd6
+Subproject commit 63b16b648cf32af6917d9a1ad419273430ff5db8

diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci
index a7731d3..7777163 160000 (submodule)
--- a/docs/submodules/releng-xci
+++ b/docs/submodules/releng-xci
@@ -1 +1 @@
-Subproject commit a7731d320ffc368b67c48c7f4d3f0f318c735e19
+Subproject commit 7777163b52f2a440b9e0ee0b6b3972017b911a0f

diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf
index 3981ce6..ca2085d 160000 (submodule)
--- a/docs/submodules/samplevnf
+++ b/docs/submodules/samplevnf
@@ -1 +1 @@
-Subproject commit 3981ce6fed44db09af235100526ab8bc1666e38e
+Subproject commit ca2085d3c7a630da6a1f28ee49b605d214d6b2e7

diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn
index fdabb0a..785cd7b 160000 (submodule)
--- a/docs/submodules/sdnvpn
+++ b/docs/submodules/sdnvpn
@@ -1 +1 @@
-Subproject commit fdabb0a5e92200c09e1476be01bf4353b0823e63
+Subproject commit 785cd7b2bfd56a0f157898335a27ecf4ca9de782

diff --git a/docs/submodules/sfc b/docs/submodules/sfc
index 31177af..9fc4127 160000 (submodule)
--- a/docs/submodules/sfc
+++ b/docs/submodules/sfc
@@ -1 +1 @@
-Subproject commit 31177afd6821f65e2601cb2b928624ba8f3d0216
+Subproject commit 9fc412714c038f69f959105e1f5dc8e8a670d0b9

diff --git a/docs/submodules/snaps b/docs/submodules/snaps
index dc76020..0e11064 160000 (submodule)
--- a/docs/submodules/snaps
+++ b/docs/submodules/snaps
@@ -1 +1 @@
-Subproject commit dc76020bee7085a3e2e9d1bd94e4ad7904d3b77d
+Subproject commit 0e11064b4b5f49ec792784d9032161cbb3b8b023

diff --git a/docs/submodules/storperf b/docs/submodules/storperf
index fbdded2..64c8b3b 160000 (submodule)
--- a/docs/submodules/storperf
+++ b/docs/submodules/storperf
@@ -1 +1 @@
-Subproject commit fbdded2f8141d68c81c5d72a11ab3a9b121c3181
+Subproject commit 64c8b3b561ccac6159241cd0485a3259887c6bb0

diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf
index be271ae..7440717 160000 (submodule)
--- a/docs/submodules/vswitchperf
+++ b/docs/submodules/vswitchperf
@@ -1 +1 @@
-Subproject commit be271aef854887fce72d821a8589dfd4ebbe8e1d
+Subproject commit 7440717327dabe7ae37f99cb060bce43a7878096

diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
index be5e495..7e2c35c 160000 (submodule)
--- a/docs/submodules/yardstick
+++ b/docs/submodules/yardstick
@@ -1 +1 @@
-Subproject commit be5e495a1cb7ab97b9202900defaf00dbd773054
+Subproject commit 7e2c35c4c33563d2007398f19f924cef9055ef4d

diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in
index a5886cd..34bc066 100644 (file)
--- a/opnfv-theme/MANIFEST.in
+++ b/opnfv-theme/MANIFEST.in
@@ -2,6 +2,6 @@ include *.txt
 include *.rst
 
 recursive-include sphinx_opnfv_theme *
-recursive-include sphinx_opnfv_theme/opnfv *
+recursive-include sphinx_opnfv_theme/static *
 
 global-exclude *.pyc

diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst
index 484a7a7..c307768 100644 (file)
--- a/opnfv-theme/README.rst
+++ b/opnfv-theme/README.rst
@@ -12,21 +12,23 @@ Here's how to install the theme from PyPI_
 
 To install and configure the theme do the following.
 
-#. Install the theme from pypi::
+#. Install the theme from pypi:
 
-   $ pip install sphinx_opnfv_theme
+   .. code-block:: bash
+
+      $ pip install sphinx_opnfv_theme
 
 #. Configure Sphinx to use the theme:
 
-.. code-block:: python
+   .. code-block:: python
 
-   # conf.py
-   import sphinx_opnfv_theme
+      # conf.py
+      import sphinx_opnfv_theme
 
-   # ...
+      # ...
 
-   html_theme = 'opnfv'
-   html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
+      html_theme = 'opnfv'
+      html_theme_path = sphinx_opnfv_theme.get_html_theme_path()
 
 Customization
 -------------
@@ -39,7 +41,7 @@ following options for the bootstrap theme::
 
   html_theme_options = {
     'bootswatch_theme': 'journal',
-    'navbar_sidebarrel': false,
+    'navbar_sidebarrel': False,
     'navbar_title': '',
   }
 

diff --git a/opnfv-theme/setup.py b/opnfv-theme/setup.py
index 5375c09..55f55bc 100644 (file)
--- a/opnfv-theme/setup.py
+++ b/opnfv-theme/setup.py
@@ -2,29 +2,29 @@ from setuptools import setup, find_packages
 
 from sphinx_opnfv_theme import __version__
 
-with open('README.rst') as f:
-    readme_text = f.read()
 
 setup(
     name='sphinx_opnfv_theme',
     description="OPNFV Theme for Sphinx",
-    long_description=readme_text,
+    long_description=open('README.rst').read(),
     url='https://docs.opnfv.org/',
     author='Trevor Bramwell',
     author_email='tbramwell@linuxfoundation.org',
     version=__version__,
-    entry_points = {
+    entry_points={
         'sphinx.html_themes': [
             'opnfv = sphinx_opnfv_theme',
         ]
     },
     packages=find_packages(),
-    install_requires = [
+    install_requires=[
         'sphinx_bootstrap_theme',
-        'sphinxcontrib.httpdomain',
+        'sphinxcontrib-httpdomain',
     ],
     include_package_data=True,
-    package_data = {
-        'sphinx_opnfv_theme': ['opnfv/**',]
-    },
+    package_data={'sphinx_opnfv_theme': [
+        'theme.conf',
+        'static/*',
+        '*.html',
+    ]},
 )

diff --git a/opnfv-theme/sphinx_opnfv_theme/__init__.py b/opnfv-theme/sphinx_opnfv_theme/__init__.py
index 0079275..2bf05c3 100644 (file)
--- a/opnfv-theme/sphinx_opnfv_theme/__init__.py
+++ b/opnfv-theme/sphinx_opnfv_theme/__init__.py
@@ -2,7 +2,7 @@
 
 from os import path
 
-__version__='0.1.1'
+__version__ = '0.2.0'
 
 
 def get_html_theme_path():
@@ -10,6 +10,7 @@ def get_html_theme_path():
     local_path = path.abspath(path.dirname(__file__))
     return [local_path]
 
+
 def setup(app):
     """Required by Sphinx to create the theme."""
     app.add_html_theme('opnfv', path.abspath(path.dirname(__file__)))

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html b/opnfv-theme/sphinx_opnfv_theme/layout.html
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html
rename to opnfv-theme/sphinx_opnfv_theme/layout.html

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html b/opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html
rename to opnfv-theme/sphinx_opnfv_theme/my_custom_sidebar.html

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html b/opnfv-theme/sphinx_opnfv_theme/relations.html
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html
rename to opnfv-theme/sphinx_opnfv_theme/relations.html

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/static/favicon.ico
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico
rename to opnfv-theme/sphinx_opnfv_theme/static/favicon.ico

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/static/logo.png
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png
rename to opnfv-theme/sphinx_opnfv_theme/static/logo.png

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/static/my-styles.css
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css
rename to opnfv-theme/sphinx_opnfv_theme/static/my-styles.css

diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf b/opnfv-theme/sphinx_opnfv_theme/theme.conf
similarity index 100%
rename from opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf
rename to opnfv-theme/sphinx_opnfv_theme/theme.conf