summaryrefslogtreecommitdiffstats
path: root/docs/testing/user/configguide
diff options
context:
space:
mode:
authorAric Gardner <agardner@linuxfoundation.org>2018-09-14 17:07:38 -0400
committerCédric Ollivier <cedric.ollivier@orange.com>2018-10-17 13:40:09 +0200
commit49a9ccba71132dda6dd90938928e761d3ef077f2 (patch)
tree1a87566aa6a050fd5f48379dea5d6408bec13d09 /docs/testing/user/configguide
parenteb4ea1b039d4141c488fb0146992b6cbe23fa4d5 (diff)
Fix links to remove references to submodules
It forces one single documentation. Change-Id: I47edd947885a4c3fb9e6579cf61fa7473b47ba31 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> (cherry picked from commit a4990a60c9b8e499e698fab28f9368816e50c6f7)
Diffstat (limited to 'docs/testing/user/configguide')
-rw-r--r--docs/testing/user/configguide/ci.rst4
-rw-r--r--docs/testing/user/configguide/conf.py177
-rw-r--r--docs/testing/user/configguide/configguide.rst1
-rw-r--r--docs/testing/user/configguide/index.rst19
-rw-r--r--docs/testing/user/configguide/intro.rst4
-rw-r--r--docs/testing/user/configguide/prerequisites.rst1
6 files changed, 10 insertions, 196 deletions
diff --git a/docs/testing/user/configguide/ci.rst b/docs/testing/user/configguide/ci.rst
index f0ed5218a..483fb4d6e 100644
--- a/docs/testing/user/configguide/ci.rst
+++ b/docs/testing/user/configguide/ci.rst
@@ -11,6 +11,6 @@ container from Jenkins.
vnf)
* functest-store-results: push logs to artifacts
-See `[3]`_ for details.
+See `[2]`_ for details.
-.. _`[3]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yaml
+.. _`[2]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yaml
diff --git a/docs/testing/user/configguide/conf.py b/docs/testing/user/configguide/conf.py
deleted file mode 100644
index 738b6414b..000000000
--- a/docs/testing/user/configguide/conf.py
+++ /dev/null
@@ -1,177 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Functest Installation Guide 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 Installation Guide'
-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 = 'FunctestInstallationGuidedoc'
-
-
-# -- 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,
- 'FunctestInstallationGuide.tex',
- u'Functest Installation Guide 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,
- 'functestinstallationguide',
- u'Functest Installation Guide 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,
- 'FunctestInstallationGuide',
- u'Functest Installation Guide Documentation',
- author,
- 'FunctestInstallationGuide',
- 'One line description of project.',
- 'Miscellaneous'),
-]
diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst
index c36da3b1d..17b2d9ec9 100644
--- a/docs/testing/user/configguide/configguide.rst
+++ b/docs/testing/user/configguide/configguide.rst
@@ -633,7 +633,6 @@ and install the **docker-engine**. The instructions conclude with a
work with the above pre-requisite actions.
-.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
.. _`dockerdocs`: https://docs.docker.com/
.. _`Proxy`: https://docs.docker.com/engine/admin/systemd/#http-proxy
.. _`Install Docker on CentOS`: https://docs.docker.com/engine/installation/linux/centos/
diff --git a/docs/testing/user/configguide/index.rst b/docs/testing/user/configguide/index.rst
index aeb9e2ba6..e749cb225 100644
--- a/docs/testing/user/configguide/index.rst
+++ b/docs/testing/user/configguide/index.rst
@@ -1,4 +1,5 @@
.. SPDX-License-Identifier: CC-BY-4.0
+.. _functest-install-guide:
***************************
Functest Installation Guide
@@ -17,21 +18,15 @@ References
`[1]`_ : Keystone and public end point constraint
-`[2]`_ : Functest User guide
+`[2]`_ : Functest Jenkins jobs
-`[3]`_ : Functest Jenkins jobs
+`[3]`_ : OPNFV main site
-`[4]`_ : Functest Configuration guide
-
-`[5]`_ : OPNFV main site
-
-`[6]`_ : Functest wiki page
+`[4]`_ : Functest wiki page
IRC support channel: #opnfv-functest
.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
-.. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
-.. _`[3]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yaml
-.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
-.. _`[5]`: http://www.opnfv.org
-.. _`[6]`: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
+.. _`[2]`: https://git.opnfv.org/releng/tree/jjb/functest/functest-daily-jobs.yaml
+.. _`[3]`: http://www.opnfv.org
+.. _`[4]`: https://wiki.opnfv.org/display/functest/Opnfv+Functional+Testing
diff --git a/docs/testing/user/configguide/intro.rst b/docs/testing/user/configguide/intro.rst
index 72730b253..d20eb111c 100644
--- a/docs/testing/user/configguide/intro.rst
+++ b/docs/testing/user/configguide/intro.rst
@@ -86,6 +86,4 @@ however, it would be possible to adapt them to any OpenStack based VIM +
controller environment, since most of the test cases are integrated from
upstream communities.
-The functional test cases are described in the Functest User `[2]`_
-
-.. _`[2]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
+The functional test cases are described in the :ref:`functest-userguide`
diff --git a/docs/testing/user/configguide/prerequisites.rst b/docs/testing/user/configguide/prerequisites.rst
index 60be1b93b..6155882d3 100644
--- a/docs/testing/user/configguide/prerequisites.rst
+++ b/docs/testing/user/configguide/prerequisites.rst
@@ -102,4 +102,3 @@ determine the needed IP addresses for each node in the SUT may vary according
to the used installer and are therefore ommitted here.
.. _`[1]`: https://ask.openstack.org/en/question/68144/keystone-unable-to-use-the-public-endpoint/
-.. _`[4]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html