diff options
51 files changed, 189 insertions, 0 deletions
diff --git a/.gitmodules b/.gitmodules index 7bf4296c7..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 @@ -232,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/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 e1eda223437eed7bef2bdfa7bef990a6749f167 +Subproject f6dbb3929d904b4d5a9ee01f8270051e29ac1ec diff --git a/docs/submodules/armband b/docs/submodules/armband -Subproject f7a780a85429d1975e3109e67760865d2ee2226 +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 7be7d9aea103e9bd1073bbb1e8fd7583e5c598c +Subproject 5a4019bc766c2f56c1299a740a270d30dd675c9 diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks -Subproject c9dc6c5ff980c32f82b0533e5a25eabebfbd0c6 +Subproject d10c4644d44f707998c7f05dc72ec4913576b75 diff --git a/docs/submodules/calipso b/docs/submodules/calipso -Subproject 63d84c1d2c950f50e45a5638afb4952b2fa9d46 +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 8eb47e0ac350a4609f3b0573e5a8e3f38b7b44d +Subproject 9c5ae544e3f1adbc5bb0df1fc7388012bdf642f diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv -Subproject 97b14e970658feeece72a6f7d705a3e50ed82a4 +Subproject 37d1f77bd177b6087372dbdcc3ca626c351c883 diff --git a/docs/submodules/daisy b/docs/submodules/daisy -Subproject f4c8d7c8017e26f5dd000b0e576c5de24e31fa2 +Subproject 443488e6af0aa1a82997907cf7a426863eb4a15 diff --git a/docs/submodules/doctor b/docs/submodules/doctor -Subproject 888af5e40c21c1cef22e968c076908f1601c53f +Subproject 631c3f99f0e499edd1adcbc7550dd3d0de393e3 diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail -Subproject ff2a7b3f7de37e64164250b8fa9a623dd061bac +Subproject caf95e09ef0206354b46d51f83690e20bc69e84 diff --git a/docs/submodules/fuel b/docs/submodules/fuel -Subproject 6acecf3b104a072c60d071364344b9ff0499416 +Subproject b3b4b2e1bcd42f4628e53796c3dab81151f56bc diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject e0aa936b1f3526e3e519cdf9aabf9be6247c776 +Subproject b20211aedd531e0d4875fde9e618c25faa8721e diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6 -Subproject 5058fb93bbb60151d74ad2ed7a7886af0b17a34 +Subproject 809dba7f52ff1571a760a01376530de23c5d97c diff --git a/docs/submodules/joid b/docs/submodules/joid -Subproject 9c6d9f01489f5867ed84a9c04416ecbfce8254d +Subproject 976a5aa1011379c4a82b13f8dde4b76cbec1ba1 diff --git a/docs/submodules/moon b/docs/submodules/moon -Subproject 9da7ac6718d66b73ba7fc8fc70e656a70e4db76 +Subproject a19855fbfe845104bbb73b53985fe0aa9b76ad4 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 298511bb572ffeb460f7ccbebe06233a17e6b79 +Subproject e1df419918039eda72c0237729511c83b4cdb38 diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv -Subproject e0e7d50a8dbf70117baec66451df7f594a7db23 +Subproject c3106a47dd483f0dd736343789a0e307595d3d8 diff --git a/docs/submodules/parser b/docs/submodules/parser -Subproject d6c75bcf6eb3dd88a2dee1478236dcf09b73daf +Subproject 2fb1e566b5cf237b17619519746b066614719c2 diff --git a/docs/submodules/pharos b/docs/submodules/pharos -Subproject 77b600ef0d64210c1b5fd72581cfe7752fa00c8 +Subproject 131e93bc72e6f25855e39c72f9efebd062d5a1e diff --git a/docs/submodules/promise b/docs/submodules/promise -Subproject 335b8446a9cb142b82a6b5cd1c2231d8185416c +Subproject 7c28b66a376d8a441c40c2926b218497d63516a diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject 17ff15959005c3c6f72a9b91192de7d54734a00 +Subproject edc7b4d604bc916705294656886eae8e93f7611 diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject 3fd9fd53bbcd887a3189bc276408806f8ee8d64 +Subproject a0df693b4e7d567adec158f6cc11b5b7cdadf56 diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci -Subproject 23e3c26a3246a4a933710b7bb1845a077b01517 +Subproject 8f3c33c97acc5fc10a83e7cc7635da67e246076 diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf -Subproject 7fa9c0b506709a683ec8984e19e9ba9deb27e02 +Subproject 37d81265d5e06c2ad87446511681259222c9498 diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn -Subproject 37889e4e2703cd3f2ba3514449ec94b3d933538 +Subproject fab5676180d3c00f0e71f89766a026f51a0cab8 diff --git a/docs/submodules/sfc b/docs/submodules/sfc -Subproject 575a8c98517c587dfdccfad93a6ea119ad68962 +Subproject 9dda531e8e9be93b930b89d45a395085fbcb61c diff --git a/docs/submodules/snaps b/docs/submodules/snaps -Subproject 9cf59ae0a133b0c8ab3907c84ec3c7b962df599 +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 0869c3a314d864d65b2d9faf98653378e411d49 +Subproject ce8adafbccb4bc37930f95561fa24874906013a diff --git a/docs/submodules/ves b/docs/submodules/ves -Subproject 0c7d63282c5c88c7f50eb68b720013e6ff579ba +Subproject 6e0bfeb045314a0964bffee025889619d427522 diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf -Subproject 23eff36d6a4b9e42ce06152e2b75e50fb7aaa5c +Subproject a9655607f7618fd392cf719e8d9ea2dbf6c8dd1 diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject e5775e7efbc55f116b4d4ac11ff87b8d8553247 +Subproject 9f98dcb078f412157284399e210f26b0eec80ae 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] |
