Add documents to document roles and jobs and a job to test these.

These are not published yet since I don't know where to publish them
currently. Let's add them so that we can ensure that no breakage is
introduced.

Change-Id: I013ab998aba182a29ff4345c975b332406b1a197
This commit is contained in:
Andreas Jaeger 2019-02-09 11:42:05 +01:00
parent 2fb73ee8fa
commit dc08b526f6
6 changed files with 114 additions and 0 deletions

5
README.rst Normal file
View File

@ -0,0 +1,5 @@
OpenDev Base Jobs
=================
This repo contains a set of Zuul jobs and Ansible roles suitable for
use by any OpenDev project.

85
doc/source/conf.py Executable file
View File

@ -0,0 +1,85 @@
# -*- 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.
# -- General configuration ----------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
# 'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
'zuul_sphinx',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
# The suffix of source filenames.
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'base-jobs'
copyright = u'2019, Zuul contributors'
# 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
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
]
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = '_static/logo.svg'
# 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']

13
doc/source/index.rst Normal file
View File

@ -0,0 +1,13 @@
.. include:: ../../README.rst
.. toctree::
:maxdepth: 1
jobs
roles
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`

5
doc/source/jobs.rst Normal file
View File

@ -0,0 +1,5 @@
Jobs
=====
.. zuul:autojobs::

4
doc/source/roles.rst Normal file
View File

@ -0,0 +1,4 @@
Roles
=====
.. zuul:autoroles::

View File

@ -144,6 +144,8 @@
- site_logs
- project:
templates:
- build-tox-docs
check:
jobs:
- openstack-zuul-jobs-linters