Fix links to remove references to submodules 41/63641/1
authorAric Gardner <agardner@linuxfoundation.org>
Fri, 14 Sep 2018 21:07:38 +0000 (17:07 -0400)
committerCédric Ollivier <cedric.ollivier@orange.com>
Wed, 17 Oct 2018 11:41:48 +0000 (13:41 +0200)
It forces one single documentation.

Change-Id: I47edd947885a4c3fb9e6579cf61fa7473b47ba31
Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
(cherry picked from commit a4990a60c9b8e499e698fab28f9368816e50c6f7)

15 files changed:
docs/release/release-notes/conf.py [deleted file]
docs/rtd/conf.py [moved from docs/testing/user/userguide/conf.py with 91% similarity]
docs/testing/developer/devguide/conf.py [deleted file]
docs/testing/user/configguide/ci.rst
docs/testing/user/configguide/conf.py [deleted file]
docs/testing/user/configguide/configguide.rst
docs/testing/user/configguide/index.rst
docs/testing/user/configguide/intro.rst
docs/testing/user/configguide/prerequisites.rst
docs/testing/user/userguide/index.rst
docs/testing/user/userguide/intro.rst
docs/testing/user/userguide/runfunctest.rst
docs/testing/user/userguide/test_details.rst
setup.cfg
tox.ini

diff --git a/docs/release/release-notes/conf.py b/docs/release/release-notes/conf.py
deleted file mode 100644 (file)
index a2421ca..0000000
+++ /dev/null
@@ -1,176 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Functest Release Notes documentation build configuration file, created by
-# sphinx-quickstart on Tue Apr  3 03:40:39 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 Release Notes'
-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 = 'FunctestReleaseNotesdoc'
-
-
-# -- 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, 'FunctestReleaseNotes.tex',
-     u'Functest Release Notes 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,
-     'functestreleasenotes',
-     u'Functest Release Notes 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,
-     'FunctestReleaseNotes',
-     u'Functest Release Notes Documentation',
-     author,
-     'FunctestReleaseNotes',
-     'One line description of project.',
-     'Miscellaneous'),
-]
similarity index 91%
rename from docs/testing/user/userguide/conf.py
rename to docs/rtd/conf.py
index 7b16ecf..2be6a5a 100644 (file)
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 #
-# Functest User Guide documentation build configuration file, created by
-# sphinx-quickstart on Wed Apr  4 04:05:42 2018.
+# 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.
@@ -44,7 +44,7 @@ source_suffix = '.rst'
 master_doc = 'index'
 
 # General information about the project.
-project = u'Functest User Guide'
+project = u'Functest'
 copyright = u'2018, Functest <opnfv-tech-discuss@lists.opnfv.org>'
 author = u'Functest <opnfv-tech-discuss@lists.opnfv.org>'
 
@@ -113,7 +113,7 @@ html_sidebars = {
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'FunctestUserGuidedoc'
+htmlhelp_basename = 'Functestdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -141,8 +141,8 @@ latex_elements = {
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
     (master_doc,
-     'FunctestUserGuide.tex',
-     u'Functest User Guide Documentation',
+     'Functest.tex',
+     u'Functest Documentation',
      u'Functest \\textless{}opnfv-tech-discuss@lists.opnfv.org\\textgreater{}',
      'manual'),
 ]
@@ -154,8 +154,8 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
     (master_doc,
-     'functestuserguide',
-     u'Functest User Guide Documentation',
+     'functest',
+     u'Functest Documentation',
      [author],
      1)
 ]
@@ -168,10 +168,10 @@ man_pages = [
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc,
-     'FunctestUserGuide',
-     u'Functest User Guide Documentation',
+     'Functest',
+     u'Functest Documentation',
      author,
-     'FunctestUserGuide',
+     'Functest',
      'One line description of project.',
      'Miscellaneous'),
 ]
diff --git a/docs/testing/developer/devguide/conf.py b/docs/testing/developer/devguide/conf.py
deleted file mode 100644 (file)
index 017dda0..0000000
+++ /dev/null
@@ -1,177 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Functest Developer Guide documentation build configuration file, created by
-# sphinx-quickstart on Wed Apr  4 05:36:49 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 Developer 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 = 'FunctestDeveloperGuidedoc'
-
-
-# -- 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,
-     'FunctestDeveloperGuide.tex',
-     u'Functest Developer 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,
-     'functestdeveloperguide',
-     u'Functest Developer 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,
-     'FunctestDeveloperGuide',
-     u'Functest Developer Guide Documentation',
-     author,
-     'FunctestDeveloperGuide',
-     'One line description of project.',
-     'Miscellaneous'),
-]
index f0ed521..483fb4d 100644 (file)
@@ -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 (file)
index 738b641..0000000
+++ /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'),
-]
index 070a77e..21792aa 100644 (file)
@@ -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/
index aeb9e2b..e749cb2 100644 (file)
@@ -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
index 72730b2..d20eb11 100644 (file)
@@ -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`
index 60be1b9..6155882 100644 (file)
@@ -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
index d59d53d..1bb67e2 100644 (file)
@@ -21,8 +21,6 @@ Functest User Guide
 References
 ==========
 
-`[1]`_: Functest configuration guide
-
 `[2]`_: OpenStack Tempest documentation
 
 `[3]`_: Rally documentation
@@ -43,8 +41,6 @@ References
 
 `[11]`_: Robot Framework web site
 
-`[12]`_: Functest User guide
-
 `[13]`_: SNAPS wiki
 
 `[14]`_: vRouter
@@ -59,7 +55,6 @@ References
 
 IRC support chan: #opnfv-functest
 
-.. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
 .. _`[2]`: http://docs.openstack.org/developer/tempest/overview.html
 .. _`[3]`: https://rally.readthedocs.org/en/latest/index.html
 .. _`[4]`: http://events.linuxfoundation.org/sites/events/files/slides/Functest%20in%20Depth_0.pdf
@@ -70,11 +65,10 @@ IRC support chan: #opnfv-functest
 .. _`[9]`: https://github.com/openstack/defcore
 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
 .. _`[11]`: http://robotframework.org/
-.. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
 .. _`[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://docs.opnfv.org/en/latest/testing/testing-dev.html
+.. _`[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
index 0c36cd8..c001afb 100644 (file)
@@ -7,6 +7,4 @@ The goal of this document is to describe the OPNFV Functest test cases and to
 provide a procedure to execute them.
 
 **IMPORTANT**: It is assumed here that Functest has been properly deployed
-following the installation guide procedure  `[1]`_.
-
-.. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
+following the installation guide procedure  :ref:`functest-install-guide`.
index bb01db7..d7d7afa 100644 (file)
@@ -3,8 +3,8 @@
 Executing Functest suites
 =========================
 
-As mentioned in the configuration guide `[1]`_, Alpine docker containers have
-been introduced in Euphrates.
+As mentioned in the :ref:`functest-install-guide`, Alpine docker containers
+have been introduced in Euphrates.
 Tier containers have been created.
 Assuming that you pulled the container and your environement is ready, you can
 simply run the tiers by typing (e.g. with functest-healthcheck)::
@@ -111,5 +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]`_.
 
 
-.. _`[1]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/configguide/index.html
-.. _`[16]`: http://docs.opnfv.org/en/latest/testing/testing-dev.html
+.. _`[16]`: http://testresults.opnfv.org/test/#/
index 03020f7..53078ea 100644 (file)
@@ -482,7 +482,6 @@ The kubernetes testcases are distributed across various Tiers:
 .. _`[9]`: https://github.com/openstack/defcore
 .. _`[10]`: https://github.com/openstack/interop/blob/master/2016.08/procedure.rst
 .. _`[11]`: http://robotframework.org/
-.. _`[12]`: http://docs.opnfv.org/en/latest/submodules/functest/docs/testing/user/userguide/index.html
 .. _`[13]`: https://wiki.opnfv.org/display/PROJ/SNAPS-OO
 .. _`[14]`: https://github.com/oolorg/opnfv-functest-vrouter
 .. _`[15]`: https://www.rebaca.com/abot-test-orchestration-tool/
index b311ce8..954dcaa 100644 (file)
--- a/setup.cfg
+++ b/setup.cfg
@@ -47,7 +47,7 @@ xtesting.testcase =
 
 [build_sphinx]
 all_files = 1
-build-dir = api/_build/
+build-dir = api/build/
 source-dir = api
 
 [wheel]
diff --git a/tox.ini b/tox.ini
index 4fda3b5..fa038f5 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -23,19 +23,12 @@ basepython = python2.7
 commands =
   doc8 \
     --ignore-path api/build \
-    --ignore-path docs/release/release-notes/build \
-    --ignore-path docs/testing/developer/devguide/build \
-    --ignore-path docs/testing/user/configguide/build \
-    --ignore-path docs/testing/user/userguide/build \
+    --ignore-path docs/build \
+    --ignore-path docs/_build \
     api \
-    docs/release/release-notes \
-    docs/testing/user/configguide \
-    docs/testing/user/userguide
+    docs
   sphinx-build -W -b html api/ api/build
-  sphinx-build -W -n -b html docs/release/release-notes docs/release/release-notes/build/html
-  sphinx-build -W -n -b html docs/testing/developer/devguide docs/testing/developer/devguide/build/html
-  sphinx-build -W -n -b html docs/testing/user/configguide docs/testing/user/configguide/build/html
-  sphinx-build -W -n -b html docs/testing/user/userguide docs/testing/user/userguide/build/html
+  sphinx-build -W -n -b html -c docs/rtd docs docs/build/html
   sphinx-build -W -n -b linkcheck docs docs/_build/linkcheck
   sphinx-build -W -n -b html docs docs/_build/html