Initial commit for docs

Start creating the structure needed to run tox-docs on our project.

Change-Id: Ia9431073189be91fbfdd36fa0781e4bd504adedb
Depends-On: I5999b95cd1e8140118ed65cd35ff87931da79d52
Signed-off-by: Paul Belanger <pabelanger@redhat.com>
changes/41/466341/5
Paul Belanger 5 years ago
parent d67a05aef5
commit 5ca3b67305
No known key found for this signature in database
GPG Key ID: 611A80832067AF38
  1. 10
      .gitignore
  2. 2
      .zuul.yaml
  3. 75
      doc/source/conf.py
  4. 10
      doc/source/index.rst
  5. 3
      playbooks/tox/docs-post.yaml
  6. 21
      setup.cfg
  7. 28
      setup.py
  8. 9
      test-requirements.txt
  9. 3
      tox.ini

10
.gitignore vendored

@ -0,0 +1,10 @@
# Unit test / coverage reports
.coverage
.tox
# Sphinx
doc/build
# pbr generates these
AUTHORS
ChangeLog

@ -29,6 +29,7 @@
name: tox-docs
parent: tox
run: tox/docs
post-run: tox/docs-post
- job:
name: tox-linters
@ -55,4 +56,5 @@
name: openstack-infra/openstack-zuul-jobs
check:
jobs:
- tox-docs
- tox-linters

@ -0,0 +1,75 @@
# -*- 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.
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- 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',
'oslosphinx'
]
# 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'openstack-zuul-jobs'
copyright = u'2016, OpenStack Foundation'
# 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}

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

@ -0,0 +1,3 @@
- hosts: all
roles:
- upload-sphinx-draft

@ -0,0 +1,21 @@
[metadata]
name = openstack-zuul-jobs
summary = A set of Ansible playbooks used by OpenStack projects CI system
description-file =
README.rst
author = OpenStack Infrastructure Team
author-email = openstack-infra@lists.openstack.org
home-page = http://www.openstack.org/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux
Programming Language :: Python
[build_sphinx]
all-files = 1
warning-is-error = 1
source-dir = doc/source
build-dir = doc/build

@ -0,0 +1,28 @@
# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
#
# 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.
import setuptools
# In python < 2.7.4, a lazy loading of package `pbr` will break
# setuptools if some other modules registered functions in `atexit`.
# solution from: http://bugs.python.org/issue15881#msg170215
try:
import multiprocessing # noqa
except ImportError:
pass
setuptools.setup(
setup_requires=['pbr>=2.0'],
pbr=True)

@ -1,2 +1,9 @@
hacking>=0.10,<0.11
# 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.
hacking>=0.12.0,<0.13 # Apache-2.0
bashate>=0.2
sphinx>=1.5.1,<1.6.0 # BSD
oslosphinx>=4.7.0 # Apache-2.0

@ -17,6 +17,9 @@ commands =
deps = bindep
commands = bindep test
[testenv:docs]
commands = python setup.py build_sphinx
[testenv:pep8]
commands = flake8 {posargs}

Loading…
Cancel
Save