diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/_static/android-chrome-192x192.png | bin | 0 -> 12272 bytes | |||
-rw-r--r-- | docs/_static/android-chrome-512x512.png | bin | 0 -> 54593 bytes | |||
-rw-r--r-- | docs/_static/anuket-logo.png | bin | 8991 -> 8612 bytes | |||
-rw-r--r-- | docs/_static/apple-touch-icon.png | bin | 0 -> 10775 bytes | |||
-rw-r--r-- | docs/_static/custom.css | 29 | ||||
-rw-r--r-- | docs/_static/favicon-16x16.png | bin | 0 -> 425 bytes | |||
-rw-r--r-- | docs/_static/favicon-32x32.png | bin | 0 -> 1003 bytes | |||
-rw-r--r--[-rwxr-xr-x] | docs/_static/favicon.ico | bin | 15406 -> 15406 bytes | |||
-rw-r--r-- | docs/_static/images/OPNFV_testing_group.png | bin | 87295 -> 0 bytes | |||
-rw-r--r-- | docs/_static/images/opnfvplatformgraphic.png | bin | 136767 -> 0 bytes | |||
-rw-r--r-- | docs/_static/my-styles.css | 33 | ||||
-rw-r--r-- | docs/_static/site.webmanifest | 1 | ||||
-rw-r--r-- | docs/_templates/layout.html | 9 | ||||
-rw-r--r-- | docs/_templates/my_custom_sidebar.html | 2 | ||||
-rw-r--r-- | docs/conf.py | 302 | ||||
-rw-r--r-- | docs/index.rst | 2 | ||||
-rw-r--r-- | docs/release/installation.introduction.rst | 31 | ||||
-rw-r--r-- | docs/requirements.txt | 15 |
18 files changed, 94 insertions, 330 deletions
diff --git a/docs/_static/android-chrome-192x192.png b/docs/_static/android-chrome-192x192.png Binary files differnew file mode 100644 index 000000000..74c81a35d --- /dev/null +++ b/docs/_static/android-chrome-192x192.png diff --git a/docs/_static/android-chrome-512x512.png b/docs/_static/android-chrome-512x512.png Binary files differnew file mode 100644 index 000000000..d6b7457ba --- /dev/null +++ b/docs/_static/android-chrome-512x512.png diff --git a/docs/_static/anuket-logo.png b/docs/_static/anuket-logo.png Binary files differindex 0320800f6..fe256a64a 100644 --- a/docs/_static/anuket-logo.png +++ b/docs/_static/anuket-logo.png diff --git a/docs/_static/apple-touch-icon.png b/docs/_static/apple-touch-icon.png Binary files differnew file mode 100644 index 000000000..9cfaf49e0 --- /dev/null +++ b/docs/_static/apple-touch-icon.png diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 000000000..9e2fb989c --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,29 @@ +/* Color of the top header */ +.md-header { + background-color: #16326c; +} + +/* Color of the bottom header */ +.md-tabs { + background-color: #16326c; +} + +/* Color of links */ +.md-typeset a { + color: #16326c; +} + +.md-typeset h1 { + font-size: 1.8rem; + color: rgba(0,0,0,.87); +} + +/* Hiding the content from left side navbar */ +.md-nav__title { + display: none; +} + +/* Hiding the content from the top navbar */ +.md-tabs__list { + display: none; +}
\ No newline at end of file diff --git a/docs/_static/favicon-16x16.png b/docs/_static/favicon-16x16.png Binary files differnew file mode 100644 index 000000000..fa55f39ca --- /dev/null +++ b/docs/_static/favicon-16x16.png diff --git a/docs/_static/favicon-32x32.png b/docs/_static/favicon-32x32.png Binary files differnew file mode 100644 index 000000000..e2cccffa3 --- /dev/null +++ b/docs/_static/favicon-32x32.png diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico Binary files differindex 3d410f6e9..3d410f6e9 100755..100644 --- a/docs/_static/favicon.ico +++ b/docs/_static/favicon.ico diff --git a/docs/_static/images/OPNFV_testing_group.png b/docs/_static/images/OPNFV_testing_group.png Binary files differdeleted file mode 100644 index 4b8c2c053..000000000 --- a/docs/_static/images/OPNFV_testing_group.png +++ /dev/null diff --git a/docs/_static/images/opnfvplatformgraphic.png b/docs/_static/images/opnfvplatformgraphic.png Binary files differdeleted file mode 100644 index 9d6074f02..000000000 --- a/docs/_static/images/opnfvplatformgraphic.png +++ /dev/null diff --git a/docs/_static/my-styles.css b/docs/_static/my-styles.css deleted file mode 100644 index 8feb45bfd..000000000 --- a/docs/_static/my-styles.css +++ /dev/null @@ -1,33 +0,0 @@ -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/docs/_static/site.webmanifest b/docs/_static/site.webmanifest new file mode 100644 index 000000000..45dc8a206 --- /dev/null +++ b/docs/_static/site.webmanifest @@ -0,0 +1 @@ +{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
\ No newline at end of file diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index 975cd9813..7a1cf9fe6 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -2,4 +2,11 @@ {% extends "!layout.html" %} {# Custom CSS overrides #} -{% set css_files = css_files + ['_static/my-styles.css'] %} +{% set css_files = css_files + ['_static/custom.css'] %} + +{%- block extrahead %} +{# Add custom things to the head HTML tag #} +{# Call the parent block #} + +{{ super() }} +{%- endblock %}
\ No newline at end of file diff --git a/docs/_templates/my_custom_sidebar.html b/docs/_templates/my_custom_sidebar.html index 6b259bc93..1d0dfac5a 100644 --- a/docs/_templates/my_custom_sidebar.html +++ b/docs/_templates/my_custom_sidebar.html @@ -1,3 +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 +</ul> diff --git a/docs/conf.py b/docs/conf.py index 43e8388f0..7fca3cde0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,41 +1,12 @@ -import sphinx_bootstrap_theme -import os - -# 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. -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' -needs_sphinx = '1.3' -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', 'sphinx.ext.napoleon', - 'sphinx.ext.intersphinx'] -# Disable javasphinx generation until we have a solution to long build -# times. readthedocs timesout after 902 seconds. - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. master_doc = 'index' - -# General information about the project. -project = '' +project = "Anuket Documentation" +html_title = "Anuket Documentation" copyright = '2021, Anuket. Licensed under CC BY 4.0' author = 'Anuket Project of Linux Foundation Networking' +extensions = ['sphinx.ext.intersphinx', + 'sphinx.ext.autosectionlabel' + ] +html_theme = "sphinx_material" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -51,239 +22,6 @@ release = 'Latest' # current stable release (Ex: 'stable/gambia') branch = 'latest' -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = 'en' - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['templates/*', 'how-to-use-docs/files/*', 'development/opnfvsecguide/*'] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'bootstrap' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} -html_theme_options = { - 'bootswatch_theme': "journal", - 'navbar_sidebarrel': False, -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] -html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() - -# The name for this set of Sphinx documents. -# "<project> v<release> documentation" by default. -# html_title = 'OpenDaylight Documentation v0.3.0' - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -html_logo = '_static/anuket-logo.png' - -# The name of an image file (relative to this directory) to use as a favicon of -# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -html_favicon = '_static/favicon.ico' - -# 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, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# html_last_updated_fmt = None - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# 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 - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a <link> tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# 'ja' uses this config value. -# 'zh' user can custom change `jieba` dictionary path. -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Anuket' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - #'preamble': '', - - # Latex figure (float) alignment - #'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'Anuket.tex', 'Anuket Documentation', - 'Anuket Project', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'AnuketDocs', 'Anuket Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'AnuketDocs', 'Anuket Documentation', - author, 'Anuket', '', - ''), -] - -html_sidebars = {'**': ['localtoc.html', 'relations.html'],} -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - intersphinx_mapping = {} intersphinx_mapping['airship'] = ('https://docs.anuket.io/projects/airship/en/%s' % branch, None) #intersphinx_mapping['apex'] = ('https://opnfv-apex.readthedocs.io/en/%s' % branch, None) @@ -328,3 +66,31 @@ intersphinx_mapping['stor4nfv'] = ('https://opnfv-stor4nfv.readthedocs.io/en/%s' #intersphinx_mapping['storperf'] = ('https://opnfv-storperf.readthedocs.io/en/%s' % branch, None) intersphinx_mapping['vineperf'] = ('https://docs.anuket.io/projects/vineperf/en/%s' % branch, None) #intersphinx_mapping['yardstick'] = ('https://opnfv-yardstick.readthedocs.io/en/%s' % branch, None) + +autosectionlabel_prefix_document = True +autosectionlabel_maxdepth = 4 + +html_static_path = ['_static'] +templates_path = ['_templates'] + +html_show_sourcelink = False +html_theme_options = { + 'nav_title': '', + # Set the color and the accent color + 'color_primary': 'blue-grey,', + 'color_accent': 'white', + # Visible levels of the global TOC; -1 means unlimited + 'globaltoc_depth': 0, + # If False, expand all TOC entries + 'globaltoc_collapse': False, + # If True, show hidden TOC entries + 'globaltoc_includehidden': False, + 'base_url': "https://docs.anuket.io/", + 'repo_url': 'https://gerrit.opnfv.org/', + 'repo_name': '', + 'repo_type': 'github', +} + +# Inverse png +html_logo = '_static/anuket-logo.png' +html_favicon = '_static/favicon.ico' diff --git a/docs/index.rst b/docs/index.rst index 4e59d6d7b..7236f6fbf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -14,7 +14,7 @@ and service provider networks. Participation is open to anyone, whether you are an employee of a member company or just passionate about network transformation. -`Anuket Reference Specifications <https://cntt.readthedocs.io/en/stable-kali/index.html>`_ +`Anuket Reference Specifications <https://cntt.readthedocs.io/>`_ Installation Guides and More ---------------------------- diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index a226055cf..1a2e6ec21 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -11,38 +11,35 @@ Installation Abstract ======== -This is the installation document for the Anuket Kali release, please use this document for further reference. +This is the collection of installation documents for Anuket, please use this document for further reference. -Installation Procedure -====================== +Installation procedures +======================= -Each of the test Frameworks and other projects will have separate installations procedures: see the individual project documentation. +Each of the sub-projects and test frameworks have their separate installations procedures in their individual +documentation. -- :ref:`Airship Installation Guide <airship-installation>` - :ref:`Barometer Installation Guide <barometer-docker-userguide>` - :ref:`CIRV-SDV Installation Guide <cirv-sdv-installation>` - :ref:`Kuberef Installation Guide <kuberef-installation>` - :ref:`ViNePERF installation Guide <vineperf-installation>` - -* :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` - +- :doc:`Functest Installation Guide <functest:testing/user/configguide/index>` Anuket Test Frameworks ====================== -If you have elected to install using the Anuket Kali Release toolchain, -you can begin to test once the installation is completed. -The basic deployment validation only addresses some of the capabilities in -any platform and you may want to execute more exhaustive tests. Some investigation will be required to -select the right test suites to run on your platform. +Testing can be started after the installation of the test frameworks. The basic deployment validation only addresses +some of the generic capabilities of cloud infrastructures. To run more exhaustive tests some investigation will be +required to select the right test suites to run. -Many of the Anuket test projects provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>` +Many of the Anuket test projects provide user-guide documentation and installation instructions in +:ref:`this document <testing-userguide>` -Anuket Reference Specifications -=============================== +Anuket Specifications +===================== There is no need to "install" the Anuket Reference Specifications! You can view them here: .. * :doc:`Anuket Reference Specifications <cntt-cntt:/index>` -* `Anuket Reference Specifications <https://cntt.readthedocs.io/en/stable-kali/index.html>`_ +* `Anuket Specifications <https://cntt.readthedocs.io/en/stable-kali/index.html>`_ diff --git a/docs/requirements.txt b/docs/requirements.txt index 6aeef7f26..5b543fe27 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,9 +1,6 @@ -tox -Sphinx -doc8 -docutils -setuptools -six -sphinxcontrib-httpdomain -sphinx_bootstrap_theme>=0.4.11 -Jinja2<3.1 +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. +sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2 # BSD +doc8 # Apache-2.0 +sphinx-material |