diff options
| -rw-r--r-- | docs/conf.py | 179 | ||||
| -rw-r--r-- | docs/lfreleng/_static/favicon.ico (renamed from docs/_static/favicon.ico) | 0 | ||||
| -rw-r--r-- | docs/lfreleng/_static/logo.png (renamed from docs/_static/logo.png) | bin | 58389 -> 58389 bytes | |||
| -rw-r--r-- | docs/lfreleng/conf.py | 6 | ||||
| -rw-r--r-- | docs/lfreleng/conf.yaml (renamed from docs/conf.yaml) | 0 | ||||
| -rw-r--r-- | docs/rtd/conf.py | 177 | ||||
| -rw-r--r-- | docs/testing/user/userguide/index.rst | 2 | ||||
| -rw-r--r-- | docs/testing/user/userguide/runfunctest.rst | 2 | ||||
| -rw-r--r-- | tox.ini | 4 |
9 files changed, 185 insertions, 185 deletions
diff --git a/docs/conf.py b/docs/conf.py index b76d57db0..2be6a5ab7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,177 @@ -#!/bin/env python +# -*- coding: utf-8 -*- +# +# Functest documentation build configuration file, created +# by sphinx-quickstart on Tue Apr 3 03:51:57 2018. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. -# pylint: disable=unused-wildcard-import,wildcard-import,redefined-builtin -# pylint: disable=missing-docstring +# 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 +# sys.path.insert(0, os.path.abspath('.')) -from docs_conf.conf import * # noqa +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [] + +# 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 master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Functest' +copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>' +author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = u'master' +# The full version, including alpha/beta/rc tags. +release = u'master' + +# 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 = None + +# 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 = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# 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 = 'sphinx_rtd_theme' + +# 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 = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# 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 = [] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Functestdoc' + + +# -- 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, + 'Functest.tex', + u'Functest Documentation', + u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}', + 'manual'), +] + + +# -- 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, + 'functest', + u'Functest Documentation', + [author], + 1) +] + + +# -- 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, + 'Functest', + u'Functest Documentation', + author, + 'Functest', + 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/_static/favicon.ico b/docs/lfreleng/_static/favicon.ico index e69de29bb..e69de29bb 100644 --- a/docs/_static/favicon.ico +++ b/docs/lfreleng/_static/favicon.ico diff --git a/docs/_static/logo.png b/docs/lfreleng/_static/logo.png Binary files differindex cc9d17cfa..cc9d17cfa 100644 --- a/docs/_static/logo.png +++ b/docs/lfreleng/_static/logo.png diff --git a/docs/lfreleng/conf.py b/docs/lfreleng/conf.py new file mode 100644 index 000000000..b76d57db0 --- /dev/null +++ b/docs/lfreleng/conf.py @@ -0,0 +1,6 @@ +#!/bin/env python + +# pylint: disable=unused-wildcard-import,wildcard-import,redefined-builtin +# pylint: disable=missing-docstring + +from docs_conf.conf import * # noqa diff --git a/docs/conf.yaml b/docs/lfreleng/conf.yaml index 7379d0765..7379d0765 100644 --- a/docs/conf.yaml +++ b/docs/lfreleng/conf.yaml diff --git a/docs/rtd/conf.py b/docs/rtd/conf.py deleted file mode 100644 index 2be6a5ab7..000000000 --- a/docs/rtd/conf.py +++ /dev/null @@ -1,177 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Functest documentation build configuration file, created -# by sphinx-quickstart on Tue Apr 3 03:51:57 2018. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# 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 -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [] - -# 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 master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Functest' -copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>' -author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'master' -# The full version, including alpha/beta/rc tags. -release = u'master' - -# 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 = None - -# 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 = [] - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# 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 = 'sphinx_rtd_theme' - -# 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 = {} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# 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 = [] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - '**': [ - 'relations.html', # needs 'show_related': True theme option to display - 'searchbox.html', - ] -} - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Functestdoc' - - -# -- 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, - 'Functest.tex', - u'Functest Documentation', - u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}', - 'manual'), -] - - -# -- 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, - 'functest', - u'Functest Documentation', - [author], - 1) -] - - -# -- 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, - 'Functest', - u'Functest Documentation', - author, - 'Functest', - 'One line description of project.', - 'Miscellaneous'), -] diff --git a/docs/testing/user/userguide/index.rst b/docs/testing/user/userguide/index.rst index 1bb67e2b7..988658747 100644 --- a/docs/testing/user/userguide/index.rst +++ b/docs/testing/user/userguide/index.rst @@ -68,7 +68,7 @@ IRC support chan: #opnfv-functest .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter .. _`[15]`: https://aptira.com/testing-openstack-tempest-part-1/ -.. _`[16]`: http://testresults.opnfv.org/test/#/ +.. _`[16]`: http://testresults.opnfv.org/test/ .. _`OPNFV main site`: http://www.opnfv.org .. _`Functest page`: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing .. _`OpenRC`: http://docs.openstack.org/user-guide/common/cli_set_environment_variables_using_openstack_rc.html diff --git a/docs/testing/user/userguide/runfunctest.rst b/docs/testing/user/userguide/runfunctest.rst index d7d7afaf1..aea8c02b7 100644 --- a/docs/testing/user/userguide/runfunctest.rst +++ b/docs/testing/user/userguide/runfunctest.rst @@ -111,4 +111,4 @@ In OPNFV CI we collect all the results from CI. A test API shall be available as well as a test database `[16]`_. -.. _`[16]`: http://testresults.opnfv.org/test/#/ +.. _`[16]`: http://testresults.opnfv.org/test/ @@ -28,9 +28,9 @@ commands = api \ docs sphinx-build -W -b html api/ api/build - sphinx-build -W -n -b html -c docs/rtd docs docs/build/html + sphinx-build -W -n -b html docs docs/build/html sphinx-build -W -n -b linkcheck docs docs/_build/linkcheck - sphinx-build -W -n -b html docs docs/_build/html + sphinx-build -W -n -b html -c docs/lfreleng docs docs/_build/html [testenv:pep8] basepython = python2.7 |
