diff options
60 files changed, 214 insertions, 22 deletions
diff --git a/.gitmodules b/.gitmodules index fa3effe13..846ab2455 100644 --- a/.gitmodules +++ b/.gitmodules @@ -8,6 +8,11 @@ url = ../armband branch = . ignore = dirty +[submodule "docs/submodules/auto"] + path = docs/submodules/auto + url = ../auto + branch = . + ignore = dirty [submodule "docs/submodules/bottlenecks"] path = docs/submodules/bottlenecks url = ../bottlenecks @@ -162,6 +167,11 @@ url = ../storperf branch = . ignore = dirty +[submodule "docs/submodules/stor4nfv"] + path = docs/submodules/stor4nfv + url = ../stor4nfv + branch = . + ignore = dirty [submodule "docs/submodules/ves"] path = docs/submodules/ves url = ../ves @@ -212,11 +222,6 @@ url = ../barometer branch = . ignore = dirty -[submodule "docs/submodules/infra"] - path = docs/submodules/infra - url = ../infra - branch = . - ignore = dirty [submodule "docs/submodules/releng-xci"] path = docs/submodules/releng-xci url = ../releng-xci @@ -237,3 +242,11 @@ url = https://gerrit.opnfv.org/gerrit/calipso branch = . ignore = dirty +[submodule "docs/submodules/stor4nfv"] + path = docs/submodules/stor4nfv + url = https://gerrit.opnfv.org/gerrit/stor4nfv +[submodule "docs/submodules/clover"] + path = docs/submodules/clover + url = https://gerrit.opnfv.org/gerrit/clover + branch = . + ignore = dirty diff --git a/docs/index.rst b/docs/index.rst index 2f6080412..925936c1c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,20 +12,18 @@ and service provider networks. Participation is open to anyone, whether you are an employee of a member company or just passionate about network transformation. -Release -------- - .. toctree:: :maxdepth: 1 release/overview + how-to-use-docs/getting.started release/installation.introduction release/userguide.introduction release/release-notes -Test Frameworks ---------------- +Testing Frameworks +------------------ .. toctree:: :maxdepth: 1 @@ -34,7 +32,6 @@ Test Frameworks testing/testing-user testing/testing-dev - Developer --------- @@ -42,9 +39,9 @@ Developer :maxdepth: 1 how-to-use-docs/index + `Developer On-boarding <https://wiki.opnfv.org/display/DEV/Developer+On-boarding>`_ featureprojects - Infrastructure -------------- @@ -54,3 +51,16 @@ Infrastructure infrastructure/overview infrastructure/ci infrastructure/xci + +Operations Supporting Tools +--------------------------- + +.. toctree:: + :maxdepth: 1 + + submodules/calipso/docs/release/index + +Found a typo or any other feedback? Send an email to users@opnfv.org or +talk to us on IRC_. + +.. _IRC: https://webchat.freenode.net/?channels=%23opnfv diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 02712deca..b745714f0 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -49,11 +49,7 @@ To learn more about the scenarios supported in the Euphrates release refer to th description documents provided: - :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>` -- :ref:`os-odl-fdio-ha <os-odl-fdio-ha>` -- :ref:`os-odl-fdio-noha <os-odl-fdio-noha>` - :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` -- :ref:`os-odl-bgpvpn-noha <sdnvpn-os-odl-bgpvpn-noha>` -- :ref:`os-odl-bgpvpn-ha <sdnvpn-os-odl-bgpvpn-ha>` - `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_ - `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_ - :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>` @@ -75,6 +71,8 @@ description documents provided: - :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` - :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>` - :ref:`k8-ovn-lb-noha <k8-ovn-lb-noha>` +- :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` +- :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` Installation Procedure ====================== diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 3fe891a59..8aad8a4d6 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -16,6 +16,8 @@ Project release notes: :ref:`Apex Release Notes <apex-releasenotes>` +:ref:`Auto Release Notes <auto-releasenotes>` + :ref:`Barometer Release Notes <barometer-releasenotes>` :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 02267ea80..bd448a85a 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -76,6 +76,7 @@ Feature Configuration Guides 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>` diff --git a/docs/submodules/apex b/docs/submodules/apex -Subproject 26b194b287340d4469bfcef0aaa5aacbd36c2dc +Subproject f6dbb3929d904b4d5a9ee01f8270051e29ac1ec diff --git a/docs/submodules/armband b/docs/submodules/armband -Subproject a63e41a621f1e558241f0a1e58ef75ea2a57c48 +Subproject 26ab32286d2c3daee92bd27c32a51bbbf5a281f diff --git a/docs/submodules/auto b/docs/submodules/auto new file mode 160000 +Subproject 5c8112dd4434e726da1325b0a699b9839f2f3d6 diff --git a/docs/submodules/availability b/docs/submodules/availability -Subproject cae41018b60f6b8c408ea3d766ae6f1e11416c4 +Subproject c1ee3631b59009ff61450808e2bd33fe1d4b17f diff --git a/docs/submodules/barometer b/docs/submodules/barometer -Subproject 5db64f8811b062d37ef6181fc69f503924f6ff6 +Subproject 5a4019bc766c2f56c1299a740a270d30dd675c9 diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks -Subproject 1baf04d3b5f2348977dc3481fd2dd5fac181d84 +Subproject d10c4644d44f707998c7f05dc72ec4913576b75 diff --git a/docs/submodules/calipso b/docs/submodules/calipso -Subproject 7cba26258ea17f790028a7005cb9bbbdc392338 +Subproject 2e47d8704fa0fe56ced38ddb4fc94f111079bd8 diff --git a/docs/submodules/clover b/docs/submodules/clover new file mode 160000 +Subproject 721d284c2147c9565a10e17beedf6da81722728 diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv -Subproject 6867ed406e18cc5bdfdef4791af07b54736e8a7 +Subproject 9c5ae544e3f1adbc5bb0df1fc7388012bdf642f diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv -Subproject f6951341cf2266c8188a667f89a0f1ca4744eb8 +Subproject 37d1f77bd177b6087372dbdcc3ca626c351c883 diff --git a/docs/submodules/copper b/docs/submodules/copper -Subproject 166774fd06fe94c4f6cd6ab123b8cda6ab78c51 +Subproject 37434bd4a46f7df1d3e41e9bbe613f3a2827638 diff --git a/docs/submodules/daisy b/docs/submodules/daisy -Subproject 827fe34d81854ccc3a6598e95c548530e396ea5 +Subproject 443488e6af0aa1a82997907cf7a426863eb4a15 diff --git a/docs/submodules/doctor b/docs/submodules/doctor -Subproject f71afa73f5a56474036215b598e45123578c38d +Subproject 631c3f99f0e499edd1adcbc7550dd3d0de393e3 diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail -Subproject 1ae814717f14e9e04337e5f236b6463c55f282b +Subproject caf95e09ef0206354b46d51f83690e20bc69e84 diff --git a/docs/submodules/fds b/docs/submodules/fds -Subproject b915eae3e2eefc9bc9b1674309575b18688c95e +Subproject 6eb4ed8ce9be7135ec65318b7b833f3c487498b diff --git a/docs/submodules/fuel b/docs/submodules/fuel -Subproject 52e37b795bb975b1cb3bf1f684b009848c50a2d +Subproject 10a36807bc6ec0db532a93f6dbb2b42ec1c4761 diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject 462b1f77176092d2ea075f32bf60d06920c8724 +Subproject b20211aedd531e0d4875fde9e618c25faa8721e diff --git a/docs/submodules/infra b/docs/submodules/infra deleted file mode 160000 -Subproject 70abc782669332240354aad59d03c0fa7a7e2c5 diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6 -Subproject 7a25e49c97b6a05d0a16eee4991723d80d5a69e +Subproject 809dba7f52ff1571a760a01376530de23c5d97c diff --git a/docs/submodules/joid b/docs/submodules/joid -Subproject 961a72560c9c6d1a5c3cf50c8e3358f88e901ff +Subproject 976a5aa1011379c4a82b13f8dde4b76cbec1ba1 diff --git a/docs/submodules/kvmfornfv b/docs/submodules/kvmfornfv -Subproject 7ea7eea6dab8c1b40c2626eead4ced80e77f87b +Subproject 5f28ffec33fb4b548353854abf51ff75b9814c3 diff --git a/docs/submodules/moon b/docs/submodules/moon -Subproject 60f88d9bbadc96ff434071cab070933f41220e2 +Subproject cd593ea18c5e08c6252050d1e30059674c8e3e8 diff --git a/docs/submodules/netready b/docs/submodules/netready -Subproject 38697bcef2049dc3f99e21dbfe7f591c987fb78 +Subproject a0f1cb6d759679e66d6da7fcd0471ddca22b5b6 diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench -Subproject a3c54b7fdce6084d6f64aa3cc23740381286a8f +Subproject e1df419918039eda72c0237729511c83b4cdb38 diff --git a/docs/submodules/orchestra b/docs/submodules/orchestra -Subproject 9cf364f27fd08431bfbcd58d43a5bbc18739bcb +Subproject 30b62474866c11465c9ae15af740378cde2c5e4 diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv -Subproject 8aa23198514d226d94362d8ac41151b6e6600d3 +Subproject c3106a47dd483f0dd736343789a0e307595d3d8 diff --git a/docs/submodules/parser b/docs/submodules/parser -Subproject d79a9223a16d5de44d49a7f0c324ce832e77673 +Subproject 807447282a8690e2ac29031536ade40369886d4 diff --git a/docs/submodules/pharos b/docs/submodules/pharos -Subproject 202aa48939dd66ff312027e90ee854095b066f5 +Subproject 131e93bc72e6f25855e39c72f9efebd062d5a1e diff --git a/docs/submodules/promise b/docs/submodules/promise -Subproject a7a703420f552c0df396575e893a319cc0233ea +Subproject 7c28b66a376d8a441c40c2926b218497d63516a diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject 795221ce0cbd9daf23af9f3099e29c947bcad30 +Subproject edc7b4d604bc916705294656886eae8e93f7611 diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject aeb2fa169ad452f0031ee6582fe1c9b4f47f68c +Subproject 058009d0462e11754888b7ae51b9c08fa8f0487 diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci -Subproject 1de24fc5ac68ac4857a6dfb345fa405c42ba95f +Subproject 90cce1c977844b134ba90f89eefcf3d2ac12c5f diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf -Subproject e430f537cad603a131034d01068af7757142743 +Subproject 37d81265d5e06c2ad87446511681259222c9498 diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn -Subproject 041ba89dcfed869b4d03affdf3ef93783ffe728 +Subproject fab5676180d3c00f0e71f89766a026f51a0cab8 diff --git a/docs/submodules/sfc b/docs/submodules/sfc -Subproject 9d416596f133ac7fa73e6cbbbf3adbe0fe86cc1 +Subproject 9dda531e8e9be93b930b89d45a395085fbcb61c diff --git a/docs/submodules/snaps b/docs/submodules/snaps -Subproject ef454fe1c79bd5e920a34bc7d71ff5611403528 +Subproject 65aca3d6919a3d31fa360afa01baee5ebff1fe2 diff --git a/docs/submodules/stor4nfv b/docs/submodules/stor4nfv new file mode 160000 +Subproject fcedde93eb366867ed428d362e2cb8a6b7f28b3 diff --git a/docs/submodules/storperf b/docs/submodules/storperf -Subproject 3fb6bd94d5df85111b98caf58eca256949c0806 +Subproject ce8adafbccb4bc37930f95561fa24874906013a diff --git a/docs/submodules/ves b/docs/submodules/ves -Subproject 1d476bccb3e406e1862489743be4d043ec4d286 +Subproject 6e0bfeb045314a0964bffee025889619d427522 diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf -Subproject caabba96ca0efb5e0d21ce5122da4e5fc873f4f +Subproject a9655607f7618fd392cf719e8d9ea2dbf6c8dd1 diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject 2085fd018074c2687ade484b9d7087173ea4f1c +Subproject 929832345dab22c99b1fc331902be5509551576 diff --git a/docs/testing/ecosystem/index.rst b/docs/testing/ecosystem/index.rst index f51fa19b0..669f5cc19 100644 --- a/docs/testing/ecosystem/index.rst +++ b/docs/testing/ecosystem/index.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Christopher Price (Ericsson AB) -======================== -Test Framework Overview -======================== +========================== +Testing Framework Overview +========================== .. toctree:: :maxdepth: 2 diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst index 50569a734..ef7705b6f 100644 --- a/docs/testing/ecosystem/overview.rst +++ b/docs/testing/ecosystem/overview.rst @@ -219,7 +219,7 @@ The data model is very basic, 5 objects are available: For detailed information, please go to http://artifacts.opnfv.org/releng/docs/testapi.html -The code of the Test API is hosted in the releng repository `[TST2]`_. +The code of the Test API is hosted in the releng-testresults repository `[TST2]`_. The static documentation of the Test API can be found at `[TST3]`_. The Test API has been dockerized and may be installed locally in your lab. @@ -367,7 +367,7 @@ Reference Documentation `[TST1]`_: OPNFV web site -`[TST2]`_: Test utils in Releng +`[TST2]`_: TestAPI code repository link in releng-testresults `[TST3]`_: TestAPI autogenerated documentation @@ -376,7 +376,7 @@ Reference Documentation `[TST5]`_: Testing group dashboard .. _`[TST1]`: http://www.opnfv.org -.. _`[TST2]`: https://git.opnfv.org/functest/tree/releng/utils/tests +.. _`[TST2]`: https://git.opnfv.org/releng-testresults .. _`[TST3]`: http://artifacts.opnfv.org/releng/docs/testapi.html .. _`[TST4]`: http://testresults.opnfv.org/testing/index.html#!/select/visual .. _`[TST5]`: https://opnfv.biterg.io:443/goto/283dba93ca18e95964f852c63af1d1ba diff --git a/opnfv-theme/.gitignore b/opnfv-theme/.gitignore new file mode 100644 index 000000000..83b2238da --- /dev/null +++ b/opnfv-theme/.gitignore @@ -0,0 +1,5 @@ +/dist +/build +*.egg-info +*.pyc +__pycache__ diff --git a/opnfv-theme/MANIFEST.in b/opnfv-theme/MANIFEST.in new file mode 100644 index 000000000..a5886cd20 --- /dev/null +++ b/opnfv-theme/MANIFEST.in @@ -0,0 +1,7 @@ +include *.txt +include *.rst + +recursive-include sphinx_opnfv_theme * +recursive-include sphinx_opnfv_theme/opnfv * + +global-exclude *.pyc diff --git a/opnfv-theme/README.rst b/opnfv-theme/README.rst new file mode 100644 index 000000000..484a7a793 --- /dev/null +++ b/opnfv-theme/README.rst @@ -0,0 +1,48 @@ +OPNFV Documentation Theme +========================= + +This theme is used for all OPNFV documentation and is released seperatly +from the documentation itself. It's and extention of the `Sphinx +Bootstrap Theme`_ + +Installation +------------ + +Here's how to install the theme from PyPI_ + +To install and configure the theme do the following. + +#. Install the theme from pypi:: + + $ pip install sphinx_opnfv_theme + +#. Configure Sphinx to use the theme: + +.. code-block:: python + + # conf.py + import sphinx_opnfv_theme + + # ... + + html_theme = 'opnfv' + html_theme_path = sphinx_opnfv_theme.get_html_theme_path() + +Customization +------------- + +There are no customization specific to this theme yet, but all +all customizations_ Sphinx Bootstrap Theme are supported. + +If you'd like your documentation to match OPNFV's style configure the +following options for the bootstrap theme:: + + html_theme_options = { + 'bootswatch_theme': 'journal', + 'navbar_sidebarrel': false, + 'navbar_title': '', + } + +.. _Sphinx Bootstrap Theme: https://github.com/ryan-roemer/sphinx-bootstrap-theme +.. _Pypi: http://pypi.python.org/pypi/sphinx-opnfv-theme/ +.. _customizations: https://github.com/ryan-roemer/sphinx-bootstrap-theme#customization diff --git a/opnfv-theme/setup.py b/opnfv-theme/setup.py new file mode 100644 index 000000000..5375c0940 --- /dev/null +++ b/opnfv-theme/setup.py @@ -0,0 +1,30 @@ +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, + url='https://docs.opnfv.org/', + author='Trevor Bramwell', + author_email='tbramwell@linuxfoundation.org', + version=__version__, + entry_points = { + 'sphinx.html_themes': [ + 'opnfv = sphinx_opnfv_theme', + ] + }, + packages=find_packages(), + install_requires = [ + 'sphinx_bootstrap_theme', + 'sphinxcontrib.httpdomain', + ], + include_package_data=True, + package_data = { + 'sphinx_opnfv_theme': ['opnfv/**',] + }, +) diff --git a/opnfv-theme/sphinx_opnfv_theme/__init__.py b/opnfv-theme/sphinx_opnfv_theme/__init__.py new file mode 100644 index 000000000..007927521 --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/__init__.py @@ -0,0 +1,15 @@ +"""OPNFV Sphinx Theme""" + +from os import path + +__version__='0.1.1' + + +def get_html_theme_path(): + """Return list of HTML theme paths.""" + 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/opnfv/layout.html new file mode 100644 index 000000000..ddd674cf1 --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/layout.html @@ -0,0 +1,5 @@ +{# Import the theme's layout. #} +{% extends "bootstrap/layout.html" %} + +{# Custom CSS overrides #} +{% set css_files = css_files + ['_static/my-styles.css'] %} diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html b/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html new file mode 100644 index 000000000..6b259bc93 --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/my_custom_sidebar.html @@ -0,0 +1,3 @@ +<ul class="globaltoc"> +{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=False,includehidden=theme_globaltoc_includehidden|tobool) }} +</ul>
\ No newline at end of file diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html b/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html new file mode 100644 index 000000000..5bad0b562 --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/relations.html @@ -0,0 +1,15 @@ +<center> +<div class="btn-group" role="group" aria-label="..."> + {% if prev %} + <a class="btn btn-default" href="{{ prev.link|e }}">Prev Page</a> + {% else %} + <button type="button" class="btn btn-default disabled">Prev Page</button> + {% endif %} + + {% if next %} + <a class="btn btn-default" href="{{ next.link|e }}">Next Page</a> + {% else %} + <button type="button" class="btn btn-default disabled">Next Page</button> + {% endif %} +</div> +</center>
\ No newline at end of file diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico Binary files differnew file mode 100755 index 000000000..bbe55ab40 --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/favicon.ico diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png Binary files differnew file mode 100644 index 000000000..1519503eb --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/logo.png diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css new file mode 100644 index 000000000..8feb45bfd --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/static/my-styles.css @@ -0,0 +1,33 @@ +body { + font-family: Helvetica, sans-serif; + font-size: 16px; +} + +body a { + color: #27CCC0; +} + +body a:hover { + color: #676767; +} + +.navbar-brand img { + height: 200%; + margin-top: -5%; +} + +.navbar, h1, h2, h3, h4, h5, h6 { + font-family: Helvetica, sans-serif; +} + +.navbar-text{ + color: #676767; +} + +.navbar-form.navbar-right{ + padding: 0; +} + +.navbar-form .form-control{ + width: 150px; +} diff --git a/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf b/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf new file mode 100644 index 000000000..66424aa1f --- /dev/null +++ b/opnfv-theme/sphinx_opnfv_theme/opnfv/theme.conf @@ -0,0 +1,7 @@ +[theme] +inherit = bootstrap +stylesheet = bootstrap-sphinx.css +pygments_style = tango + +# Theme Options exposed by html_theme_options +[options] |
