Move LF doc files into a new dir 39/63639/1
authorCédric Ollivier <cedric.ollivier@orange.com>
Wed, 17 Oct 2018 09:00:25 +0000 (11:00 +0200)
committerCédric Ollivier <cedric.ollivier@orange.com>
Wed, 17 Oct 2018 11:40:16 +0000 (13:40 +0200)
rtd forces conf.py to be in the root dir.
Then it moves all LF files into a dedicated dir and reverts rtd
config.py.

Change-Id: I181c76c2b06df630aedf5b9fd96415ab9b23d9e1
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
(cherry picked from commit 0d0f0d5e5f18cbb91c0119b16e737815a7756277)

docs/conf.py
docs/lfreleng/_static/favicon.ico [moved from docs/_static/favicon.ico with 100% similarity]
docs/lfreleng/_static/logo.png [moved from docs/_static/logo.png with 100% similarity]
docs/lfreleng/conf.py [new file with mode: 0644]
docs/lfreleng/conf.yaml [moved from docs/conf.yaml with 100% similarity]
docs/rtd/conf.py [deleted file]
docs/testing/user/userguide/index.rst
docs/testing/user/userguide/runfunctest.rst
tox.ini

index b76d57d..2be6a5a 100644 (file)
@@ -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/lfreleng/conf.py b/docs/lfreleng/conf.py
new file mode 100644 (file)
index 0000000..b76d57d
--- /dev/null
@@ -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
similarity index 100%
rename from docs/conf.yaml
rename to docs/lfreleng/conf.yaml
diff --git a/docs/rtd/conf.py b/docs/rtd/conf.py
deleted file mode 100644 (file)
index 2be6a5a..0000000
+++ /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'),
-]
index 1bb67e2..9886587 100644 (file)
@@ -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
index d7d7afa..aea8c02 100644 (file)
@@ -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/
diff --git a/tox.ini b/tox.ini
index 1fc6614..7e85689 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -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