X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=resources%2Ftools%2Fpresentation%2Fconf.py;h=4b52989c45af3965281303a1d3e8786c5cf4ba04;hp=6fad510f7212fff683640e1b9f46736465e64460;hb=2e6fbdb290ab6128403f1f6edcc6072644843f77;hpb=d8acc8c6a37f5a3aae87dfc642e47058fc4b9a21 diff --git a/resources/tools/presentation/conf.py b/resources/tools/presentation/conf.py index 6fad510f72..4b52989c45 100644 --- a/resources/tools/presentation/conf.py +++ b/resources/tools/presentation/conf.py @@ -1,7 +1,6 @@ # -*- coding: utf-8 -*- # -# CSIT 17.01 report documentation build configuration file, created by -# sphinx-quickstart on Sun Jan 15 09:49:36 2017. +# CSIT report documentation build configuration file # # This file is execfile()d with the current directory set to its # containing dir. @@ -15,7 +14,8 @@ # 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 @@ -36,7 +36,7 @@ extensions = ['sphinxcontrib.programoutput', # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] -# The suffix(es) of source filenames. +# The suffix(es) of source file names. # You can specify multiple suffix as a list of string: # source_suffix = ['.rst', '.md'] @@ -45,8 +45,8 @@ source_suffix = ['.rst', '.md'] master_doc = 'index' # General information about the project. -project = u'FD.io CSIT' -copyright = u'2017, FD.io' +project = u'FD.io CSIT-1810.49' +copyright = u'2018, FD.io' author = u'FD.io CSIT' # The version info for the project you're documenting, acts as replacement for @@ -54,42 +54,69 @@ author = u'FD.io CSIT' # built documents. # # The short X.Y version. -#version = u'' +# version = u'' # The full version, including alpha/beta/rc tags. -#release = u'' +# release = u'' rst_epilog = """ -.. |release-1| replace:: rls1704 -.. |vpp-release| replace:: VPP-17.10 release -.. |vpp-release-1| replace:: VPP-17.04 release -.. |dpdk-release| replace:: DPDK 17.05 -.. |trex-release| replace:: TRex v2.25 -.. |virl-image-ubuntu| replace:: ubuntu-16.04.1_2017-02-23_1.8 -.. |virl-image-centos| replace:: centos-7.3-1611_2017-02-23_1.4 - -.. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h=rls1710 -.. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h=rls1710 -.. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h=rls1710 -.. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h=rls1710 -.. _VIRL images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h=rls1710 -.. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h=rls1710 -.. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.func.honeycomb.html -.. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.perf.honeycomb.html -.. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.dpdk.perf.html -.. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.func.html -.. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.vpp.perf.html -.. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/rls1710/doc/tests.nsh_sfc.func.html -.. _VPP test framework documentation: https://docs.fd.io/vpp/17.10/vpp_make_test/html/ -.. _FD.io test executor vpp performance jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-1710-all -.. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-1710-all -.. _FD.io test executor vpp functional jobs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-1710-ubuntu1604-virl/lastSuccessfulBuild -.. _FD.io test executor dpdk performance jobs: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-1710-all -.. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-1710-ubuntu1604/lastSuccessfulBuild -.. _FD.io test executor honeycomb performance jobs: https://jenkins.fd.io/view/hc2vpp/job/hc2vpp-csit-perf-master-ubuntu1604/lastSuccessfulBuild -.. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-1710-ubuntu1604-virl/lastSuccessfulBuild -.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-1710-ubuntu1604/ -.. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h=rls1710 -""" +.. |release-1| replace:: {prev_release} +.. |srelease| replace:: {srelease} +.. |csit-release| replace:: CSIT-{csitrelease} +.. |csit-release-1| replace:: CSIT-{csit_prev_release} +.. |vpp-release| replace:: VPP-{vpprelease} release +.. |vpp-release-1| replace:: VPP-{vpp_prev_release} release +.. |dpdk-release| replace:: DPDK {dpdkrelease} +.. |trex-release| replace:: TRex {trex_version} +.. |virl-image-ubuntu| replace:: {csit_ubuntu_ver} +.. |virl-image-centos| replace:: {csit_centos_ver} + +.. _pdf version of this report: https://docs.fd.io/csit/{release}/report/_static/archive/csit_{release}.{report_week}.pdf +.. _tag documentation rst file: https://git.fd.io/csit/tree/docs/tag_documentation.rst?h={release} +.. _TRex intallation: https://git.fd.io/csit/tree/resources/tools/trex/trex_installer.sh?h={release} +.. _TRex driver: https://git.fd.io/csit/tree/resources/tools/trex/trex_stateless_profile.py?h={release} +.. _VIRL topologies directory: https://git.fd.io/csit/tree/resources/tools/virl/topologies/?h={release} +.. _VIRL ubuntu images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/ubuntu/lists/?h={release} +.. _VIRL centos images lists: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/centos/lists/?h={release} +.. _VIRL nested: https://git.fd.io/csit/tree/resources/tools/disk-image-builder/nested/?h={release} +.. _CSIT Honeycomb Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.honeycomb.html +.. _CSIT Honeycomb Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.honeycomb.html +.. _CSIT DPDK Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dpdk.perf.html +.. _CSIT VPP Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.func.html +.. _CSIT VPP Performance Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.perf.html +.. _CSIT NSH_SFC Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.nsh_sfc.func.html +.. _CSIT DMM Functional Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.dmm.func.html +.. _CSIT VPP Device Tests Documentation: https://docs.fd.io/csit/{release}/doc/tests.vpp.device.html +.. _VPP test framework documentation: https://docs.fd.io/vpp/{vpprelease}/vpp_make_test/html/ +.. _FD.io test executor dpdk performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-hsw +.. _FD.io test executor dpdk performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-3n-skx +.. _FD.io test executor dpdk performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-dpdk-perf-verify-{srelease}-2n-skx +.. _FD.io test executor vpp performance job 3n-hsw: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-3n-hsw +.. _FD.io test executor vpp performance job 3n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-3n-skx +.. _FD.io test executor vpp performance job 2n-skx: https://jenkins.fd.io/view/csit/job/csit-vpp-perf-verify-1807-2n-skx +.. _FD.io test executor ligato performance jobs: https://jenkins.fd.io/job/csit-ligato-perf-{srelease}-all +.. _FD.io test executor vpp functional jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-ubuntu1604-virl +.. _FD.io test executor vpp functional jobs using CentOs: https://jenkins.fd.io/view/csit/job/csit-vpp-functional-{srelease}-centos7-virl +.. _FD.io test executor vpp device jobs using Ubuntu: https://jenkins.fd.io/view/csit/job/csit-vpp-device-{srelease}-ubuntu1804-1n-skx +.. _FD.io test executor Honeycomb functional jobs: https://jenkins.fd.io/view/csit/job/hc2vpp-csit-integration-{srelease}-ubuntu1604 +.. _FD.io test executor NSH_SFC functional jobs: https://jenkins.fd.io/view/csit/job/csit-nsh_sfc-verify-func-{srelease}-ubuntu1604-virl +.. _FD.io test executor DMM functional jobs: https://jenkins.fd.io/view/csit/job/csit-dmm-functional-{srelease}-ubuntu1604-virl +.. _FD.io VPP compile job: https://jenkins.fd.io/view/vpp/job/vpp-merge-{srelease}-ubuntu1604/ +.. _FD.io DPDK compile job: https://jenkins.fd.io/view/deb-dpdk/job/deb_dpdk-merge-{sdpdkrelease}-ubuntu1604/ +.. _CSIT Testbed Setup: https://git.fd.io/csit/tree/resources/tools/testbed-setup/README.md?h={release} +.. _K8s configuration files: https://github.com/FDio/csit/tree/{release}/resources/templates/kubernetes +""".format(release='rls1810', + report_week='49', + prev_release='rls1807', + srelease='1810', + csitrelease='1810', + csit_prev_release='1807', + vpprelease='18.10', + vpp_prev_release='18.07', + dpdkrelease='18.08', + sdpdkrelease='1808', + trex_version='v2.35', + csit_ubuntu_ver='csit-ubuntu-16.04.1_2018-03-07_2.1', + csit_centos_ver='csit-centos-7.4-1711_2018-03-20_1.9') # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -120,7 +147,20 @@ html_theme = 'sphinx_rtd_theme' # further. For a list of options available for each theme, see the # documentation. # -# html_theme_options = {} +html_theme_options = { + 'canonical_url': '', + 'analytics_id': '', + 'logo_only': False, + 'display_version': True, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': False, + # Toc options + 'collapse_navigation': True, + 'sticky_navigation': True, + 'navigation_depth': 3, + 'includehidden': True, + 'titles_only': False +} # 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, @@ -136,6 +176,15 @@ html_context = { ], } +# If false, no module index is generated. +html_domain_indices = True + +# If false, no index is generated. +html_use_index = True + +# If true, the index is split into individual pages for each letter. +html_split_index = False + # -- Options for LaTeX output --------------------------------------------- latex_engine = 'pdflatex'