From b3bd57cf18d081464e674cf6e7dc988350ab4135 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Wed, 14 Nov 2018 15:45:31 +0100 Subject: [PATCH] Adding test infrastructure Setup repo for usual Sphinx location: * content lives in doc/source * Add tox.ini for building with linter and docs job * Add doc/source/conf.py for Sphinx * Add index file to build a manual * Add jobs for Zuul; note that tox-linters is non-voting for now, fixing issues can be done as followup. The docs job has Sphinx warnings disabled, this will be a followup as well. * Add .gitignore for usual build artefacts Change-Id: Ie7af4b6bd661e61180528cc1ecf3076e3e95590b --- .gitignore | 5 + .zuul.yaml | 7 +- doc/source/conf.py | 270 +++++++++++++++++++++++ doc/source/index.rst | 15 ++ {docs => doc/source}/introduction.rst | 0 {docs => doc/source}/opencommunity.rst | 0 {docs => doc/source}/opendesign.rst | 0 {docs => doc/source}/opendevelopment.rst | 0 {docs => doc/source}/opensource.rst | 0 test-requirements.txt | 3 + tox.ini | 22 ++ 11 files changed, 321 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst rename {docs => doc/source}/introduction.rst (100%) rename {docs => doc/source}/opencommunity.rst (100%) rename {docs => doc/source}/opendesign.rst (100%) rename {docs => doc/source}/opendevelopment.rst (100%) rename {docs => doc/source}/opensource.rst (100%) create mode 100644 test-requirements.txt create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a738f03 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +# Testenvironment +.tox + +# Build directories +doc/build diff --git a/.zuul.yaml b/.zuul.yaml index e7c200a..e26a4cc 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,3 +1,8 @@ - project: templates: - - noop-jobs + - build-openstack-docs-pti + check: + jobs: + - tox-linters: + voting: false + diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..7ab3618 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,270 @@ +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# 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. + + +# -- 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 = ['openstackdocstheme'] + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ['_templates'] + +# The suffix of source filenames. +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. +repository_name = 'openstack/four-opens' +project = u'Four Opens' +bug_project = u'four-opens' +use_storyboard = True + +# 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 = '' +# The full version, including alpha/beta/rc tags. +release = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# 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. +exclude_patterns = [] + +# 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 + + +# -- 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 = 'openstackdocs' + +# 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 = [openstackdocstheme.get_html_theme_path()] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# 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 = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# 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 = [] + +# 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 '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# So that we can enable "log-a-bug" links from each output HTML page, this +# variable must be set to a format that includes year, month, day, hours and +# minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + +# 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 = False + +# 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 = False + +# 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 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 + +# Output file base name for HTML help builder. +htmlhelp_basename = 'four-opens' + +# If true, publish source files +html_copy_source = False + +# -- 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': '', +} + +# 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 = [ + ('index', 'FourOpens.tex', u'Four Opens', + u'OpenStack contributors', '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 = [ + ('index', 'fouropens', u'Four Opens', + [u'OpenStack contributors'], 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 = [ + ('index', 'FourOpens', u'Four Opens', + u'OpenStack contributors', 'FourOpens', + 'This book explains the Four Opens of OpenStack.', + 'Miscellaneous'), +] + +# 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 + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..1e727fc --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,15 @@ +============== +The Four Opens +============== + +Contents +~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + introduction + opensource + opencommunity + opendevelopment + opendesign diff --git a/docs/introduction.rst b/doc/source/introduction.rst similarity index 100% rename from docs/introduction.rst rename to doc/source/introduction.rst diff --git a/docs/opencommunity.rst b/doc/source/opencommunity.rst similarity index 100% rename from docs/opencommunity.rst rename to doc/source/opencommunity.rst diff --git a/docs/opendesign.rst b/doc/source/opendesign.rst similarity index 100% rename from docs/opendesign.rst rename to doc/source/opendesign.rst diff --git a/docs/opendevelopment.rst b/doc/source/opendevelopment.rst similarity index 100% rename from docs/opendevelopment.rst rename to doc/source/opendevelopment.rst diff --git a/docs/opensource.rst b/doc/source/opensource.rst similarity index 100% rename from docs/opensource.rst rename to doc/source/opensource.rst diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..bfb0de8 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +openstackdocstheme>=1.18.1 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..1506e6c --- /dev/null +++ b/tox.ini @@ -0,0 +1,22 @@ +[tox] +minversion = 2.0 +skipsdist = True +envlist = docs,linters + +[testenv] +basepython = python3 +setenv = VIRTUAL_ENV={envdir} +passenv = *_proxy *_PROXY ZUUL_* + +[testenv:linters] +deps = + -r{toxinidir}/test-requirements.txt +commands = + doc8 doc/source + +[testenv:docs] +deps = + -r{toxinidir}/test-requirements.txt +commands = + sphinx-build -b html -d doc/build/doctrees doc/source doc/build/html +