From 196bee0821e9e9bba8151109084267262ee29cd6 Mon Sep 17 00:00:00 2001 From: Kevin Carter Date: Fri, 14 Jun 2019 09:03:51 -0500 Subject: [PATCH] Add releasentoes and documentation jobs This change adds documentation and releaseonte jobs which will validate docs written and publish them as needed. Change-Id: Ic517ec411fe031101f2fac96a5c5f831f203ac40 Signed-off-by: Kevin Carter --- .pre-commit-config.yaml | 2 +- doc/build/html/.gitkeep | 0 doc/requirements.txt | 10 + doc/source/_exts/.gitkeep | 0 doc/source/conf.py | 3 +- doc/source/contributing.rst | 23 ++- doc/source/index.rst | 1 + doc/source/installation.rst | 8 +- releasenotes/build/html/.gitkeep | 0 releasenotes/source/_static/.gitkeep | 0 releasenotes/source/conf.py | 269 +++++++++++++++++++++++++++ releasenotes/source/index.rst | 8 + releasenotes/source/unreleased.rst | 5 + tox.ini | 17 +- zuul.d/jobs.yaml | 7 + zuul.d/layout.yaml | 4 + 16 files changed, 342 insertions(+), 15 deletions(-) create mode 100644 doc/build/html/.gitkeep create mode 100644 doc/requirements.txt create mode 100644 doc/source/_exts/.gitkeep create mode 100644 releasenotes/build/html/.gitkeep create mode 100644 releasenotes/source/_static/.gitkeep create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4d64633ca..6217f5eba 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -11,7 +11,7 @@ repos: - id: check-merge-conflict - id: debug-statements - id: flake8 - entry: flake8 --ignore=E24,E121,E123,E124,E126,E226,E305,E402,F401,F405,E501,E704,F403,F841,W503 + entry: flake8 --ignore=E24,E121,E122,E123,E124,E126,E226,E265,E305,E402,F401,F405,E501,E704,F403,F841,W503 # TODO(cloudnull): These codes were added to pass the lint check. # All of these ignore codes should be resolved in # future PRs. diff --git a/doc/build/html/.gitkeep b/doc/build/html/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..77873540b --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,10 @@ +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +# this is required for the docs build jobs +sphinx>=2.0.0 # BSD +openstackdocstheme>=1.29.2 # Apache-2.0 +reno>=2.11.3 # Apache-2.0 +doc8>=0.8.0 # Apache-2.0 +bashate>=0.6.0 # Apache-2.0 diff --git a/doc/source/_exts/.gitkeep b/doc/source/_exts/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/doc/source/conf.py b/doc/source/conf.py index b66de9646..f28675b82 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,8 +26,7 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'openstackdocstheme', - 'sphinx.ext.autodoc', - 'workbooks' + 'sphinx.ext.autodoc' ] # autodoc generation is a bit aggressive and a nuisance when doing heavy diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index e6d300e44..efc5768d0 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -5,14 +5,17 @@ Contributing Adding roles into this project is easy and starts with a compatible skeleton. -From with the project root, creating a skeleton for the new role:: +From with the project root, creating a skeleton for the new role. + +.. code-block:: console $ ansible-galaxy init --role-skeleton=_skeleton_role_ --init-path=tripleo_ansible/roles ${NEWROLENAME} + Once the new role has been created, and is ready for testing add the role into the `tox.ini` file as an test scenario. -.. code-block:: +.. code-block:: ini [testenv:mol-${NEWROLENAME}] basepython={[testenv:mol]basepython} @@ -23,7 +26,9 @@ the `tox.ini` file as an test scenario. python -m pytest --color=yes --html={envlogdir}/reports.html --self-contained-html {tty:-s} {toxinidir}/tests/test_molecule.py -When the role is ready for CI add a jobs entry into the `zuul.d/jobs.yaml`:: +When the role is ready for CI add a jobs entry into the `zuul.d/jobs.yaml`. + +.. code-block:: yaml - job: name: tripleo-ansible-centos:mol-${NEWROLENAME} @@ -31,14 +36,16 @@ When the role is ready for CI add a jobs entry into the `zuul.d/jobs.yaml`:: files: - ^tripleo_ansible/roles/${NEWROLENAME}/.* vars: - tox_envlist: mol-${NEWROLENAME} + tox_envlist: mol-${NEWROLENAME} -And finally add the job into the `zuul.d/layout.yaml` file:: +And finally add the job into the `zuul.d/layout.yaml` file. + +.. code-block:: yaml - project: check: - jobs: + jobs: - tripleo-ansible-centos:mol-${NEWROLENAME} @@ -47,7 +54,7 @@ available on the development workstation change directory to the root of the `tripleo-ansible` repository and run the the following command which will perform all of the tasks noted above. -.. code-block:: +.. code-block:: console $ ansible-playbook -i localhost, role-addition.yml -e role_name=${NEWROLENAME} @@ -55,7 +62,7 @@ will perform all of the tasks noted above. If this playbook is being executed from a virtual-environment be sure to activate the virtual environment before running the playbook. -.. code-block:: +.. code-block:: console $ . ~/bin/venvs/ansible/bin/activate (ansible)$ ansible-playbook -i localhost, role-addition.yml -e role_name=${NEWROLENAME} diff --git a/doc/source/index.rst b/doc/source/index.rst index 69bfff7f2..24de9741c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Contents: installation contributing + usage Indices and tables ================== diff --git a/doc/source/installation.rst b/doc/source/installation.rst index d0f66f8db..5fe129ceb 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -2,11 +2,15 @@ Installation ============ -At the command line using `yum`:: +At the command line using `yum`. + +.. code-block:: console $ yum install tripleo-ansible -At the command line using `dnf`:: +At the command line using `dnf`. + +.. code-block:: console $ dnf install tripleo-ansible diff --git a/releasenotes/build/html/.gitkeep b/releasenotes/build/html/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/releasenotes/source/_static/.gitkeep b/releasenotes/source/_static/.gitkeep new file mode 100644 index 000000000..e69de29bb diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 000000000..7ac1bd235 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,269 @@ +# -*- coding: utf-8 -*- +# 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. +# + +# 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. +#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 = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +# 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. +project = u'tripleo-ansible Release Notes' +copyright = u'2019, TripleO Developers' + +# 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 full version, including alpha/beta/rc tags. +release = '' +# The short X.Y version. +version = '' + +# The full version, including alpha/beta/rc tags. + +# 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 = [] + +# 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 = ['_static'] + +# 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. +#html_last_updated_fmt = '%b %d, %Y' + +# 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 = True + +# 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 = True + +# 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 = 'tripleo-ansibleReleaseNotesdoc' + + +# -- 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', 'tripleo-ansibleReleaseNotes.tex', u'tripleo-ansible Release Notes Documentation', + u'2016, TripleO Developers', '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', 'tripleo-ansiblereleasenotes', u'tripleo-ansible Release Notes Documentation', + [u'2016, TripleO Developers'], 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', 'tripleo-ansibleReleaseNotes', u'tripleo-ansible Release Notes Documentation', + u'2016, TripleO Developers', 'tripleo-ansibleReleaseNotes', 'One line description of project.', + '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/'] + +# openstackdocstheme options +repository_name = 'openstack/tripleo-ansible' +bug_project = 'tripleo' +bug_tag = 'documentation' diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 000000000..b0e3e91c3 --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +============================= +TripleO-Ansible Release Notes +============================= + +.. toctree:: + :maxdepth: 1 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 000000000..875030f9d --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/tox.ini b/tox.ini index 90cead2b1..e2d47391b 100644 --- a/tox.ini +++ b/tox.ini @@ -84,9 +84,22 @@ commands = {[testenv:shebangs]commands} [testenv:releasenotes] -whitelist_externals = bash +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt commands = - bash -c "ci-scripts/releasenotes_tox.sh" + sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html + +[testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt +commands= + doc8 doc + sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html + +[doc8] +# Settings for doc8: +extensions = .rst +ignore = D001 [testenv:venv] commands = {posargs} diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml index e8f6015d7..dcf3621ce 100644 --- a/zuul.d/jobs.yaml +++ b/zuul.d/jobs.yaml @@ -7,6 +7,13 @@ nodeset: centos-7 voting: true +- job: + name: tripleo-ansible-docs + parent: openstack-tox-docs + files: + - ^tripleo_ansible/doc/.* + - ^tripleo_ansible/README.rst + - job: name: tripleo-ansible-centos-7-molecule-test_deps parent: tripleo-ansible-centos diff --git a/zuul.d/layout.yaml b/zuul.d/layout.yaml index a7e711cc8..04adbed7a 100644 --- a/zuul.d/layout.yaml +++ b/zuul.d/layout.yaml @@ -5,9 +5,13 @@ - openstack-tox-linters - tripleo-ansible-centos-7-molecule-test_deps - tripleo-ansible-centos-7-molecule-tuned + - tripleo-ansible-docs gate: jobs: - openstack-tox-linters post: jobs: - publish-openstack-python-branch-tarball + templates: + - publish-openstack-docs-pti + - release-notes-jobs-python3