diff options
41 files changed, 23 insertions, 106 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 18a6ea282..bde163349 100644 --- 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 8aad8a4d6..ade660c6c 100644 --- 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 3b747e61e..337bf6730 100644 --- 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 -Subproject 1abb8ac25c48d182bc267d23f618043fbd7e084 +Subproject 94ce44fe6e3450a1217ec3838a43049e53da9f6 diff --git a/docs/submodules/armband b/docs/submodules/armband -Subproject 0d7a1834aea3bde3e27892919ae731b5cdae556 +Subproject 6657baa68d238e1cba9e1d69118616e438b07f3 diff --git a/docs/submodules/auto b/docs/submodules/auto -Subproject 40e5d1ef5e5c389609ab145441375cd0a17af07 +Subproject a85a3366e4ca2094facf69b696e0c03e97ab45d diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks -Subproject 73bd5d30fb9d5ee3bc01d78b431282332a53b44 +Subproject 61aafcb0ca6cab9c25d2df7d409f4fa8716ebe5 diff --git a/docs/submodules/clover b/docs/submodules/clover -Subproject 867c4309a10df56eeb5098a78956e5d6951b8ba +Subproject 4be1d24ba88619d677f2a616239da6fa29bdb78 diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv -Subproject 3ede18e758c77b31e56ca9164dbeb8e06b0223b +Subproject d7156c0b772ada65ff3d094bd70814bf5b0cb4e diff --git a/docs/submodules/daisy b/docs/submodules/daisy -Subproject 6a7ee18538561c772b0bfbc48805e2a2de74a9c +Subproject afb9b05fc088fdb60168a2dd25dda90b5d3ab2d diff --git a/docs/submodules/doctor b/docs/submodules/doctor -Subproject f06386c6b436a0adce7b96c6a1d59b5d02ed31f +Subproject aeb2ff16a530c7c7af9a6e2d16ba5421dd074cf diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail -Subproject 749946dcc5b17cfca43c6e8692359f4972e48b2 +Subproject cb02bccdef30575bb46080475ca13fdf8b6b4b2 diff --git a/docs/submodules/fuel b/docs/submodules/fuel -Subproject 2d2f59907d578d266e1aa19040314dc15b27c0c +Subproject 9e9393ab60ff513f01b9ce045245e6c5808590a diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject b5a9b04871868633f5c92005b7665bfb76ee6ee +Subproject 454a3e3152d90ea0f64fc64ccabc1e305f1c2f9 diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6 -Subproject dfcc0745ef76e684593c8284f9dcb81cca2f795 +Subproject a1f0778b5aa40e2d179d00b941853749b58ab6a diff --git a/docs/submodules/joid b/docs/submodules/joid -Subproject c0bc95b384aa0e5a398aa35a300081919898d1d +Subproject 6345ba5917f720c00b165530916436578bd4c32 diff --git a/docs/submodules/moon b/docs/submodules/moon -Subproject e93c1de651a76f06ef0a3f247db4be5a4086013 +Subproject c975e6c2fcb7afadecf0371c30073791599c8c8 diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench -Subproject e456fff7801702f1cf672d9ebda54eabd5100ec +Subproject eff9ff971acf5c7208ab2b824b897d3183c36f3 diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv -Subproject 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88 +Subproject 114315d2972dc3cfa9c2d4f3508e2d23d3e4aab diff --git a/docs/submodules/pharos b/docs/submodules/pharos -Subproject a3c0456cc14a75e96808505e670d0cab37b30ab +Subproject 68dc60c1aa7199279995c1fee59ad151b5012af diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject 879963d90e74a4fd003bb73e8d4e50e51679f92 +Subproject c934821173ff9adb5608d4df2418ac23fa0b825 diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject 48f926a22e0b180ffe4815e333e92e181e3d0dd +Subproject 63b16b648cf32af6917d9a1ad419273430ff5db diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci -Subproject a7731d320ffc368b67c48c7f4d3f0f318c735e1 +Subproject 7777163b52f2a440b9e0ee0b6b3972017b911a0 diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf -Subproject 3981ce6fed44db09af235100526ab8bc1666e38 +Subproject ca2085d3c7a630da6a1f28ee49b605d214d6b2e diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn -Subproject fdabb0a5e92200c09e1476be01bf4353b0823e6 +Subproject 785cd7b2bfd56a0f157898335a27ecf4ca9de78 diff --git a/docs/submodules/sfc b/docs/submodules/sfc -Subproject 31177afd6821f65e2601cb2b928624ba8f3d021 +Subproject 9fc412714c038f69f959105e1f5dc8e8a670d0b diff --git a/docs/submodules/snaps b/docs/submodules/snaps -Subproject dc76020bee7085a3e2e9d1bd94e4ad7904d3b77 +Subproject 0e11064b4b5f49ec792784d9032161cbb3b8b02 diff --git a/docs/submodules/storperf b/docs/submodules/storperf -Subproject fbdded2f8141d68c81c5d72a11ab3a9b121c318 +Subproject 64c8b3b561ccac6159241cd0485a3259887c6bb diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf -Subproject be271aef854887fce72d821a8589dfd4ebbe8e1 +Subproject 7440717327dabe7ae37f99cb060bce43a787809 diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject be5e495a1cb7ab97b9202900defaf00dbd77305 +Subproject 7e2c35c4c33563d2007398f19f924cef9055ef4 diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in index a5886cd20..34bc06617 100644 --- 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 484a7a793..c307768fb 100644 --- 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 5375c0940..55f55bc92 100644 --- 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 007927521..2bf05c3ae 100644 --- 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 index ddd674cf1..ddd674cf1 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html +++ b/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 index 6b259bc93..6b259bc93 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html +++ b/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 index 5bad0b562..5bad0b562 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html +++ b/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 Binary files differindex bbe55ab40..bbe55ab40 100755 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico +++ b/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 Binary files differindex 1519503eb..1519503eb 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png +++ b/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 index 8feb45bfd..8feb45bfd 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css +++ b/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 index 66424aa1f..66424aa1f 100644 --- a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf +++ b/opnfv-theme/sphinx_opnfv_theme/theme.conf |
