summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.zuul.yaml1
-rw-r--r--doc/requirements.txt9
-rw-r--r--doc/source/images/architecture-pegleg.pngbin37602 -> 37604 bytes
-rw-r--r--releasenotes/notes/.placeholder0
-rw-r--r--releasenotes/source/_static/.placeholder0
-rw-r--r--releasenotes/source/_templates/.placeholder0
-rw-r--r--releasenotes/source/conf.py174
-rw-r--r--releasenotes/source/index.rst7
-rw-r--r--releasenotes/source/unreleased.rst5
-rw-r--r--tox.ini9
10 files changed, 203 insertions, 2 deletions
diff --git a/.zuul.yaml b/.zuul.yaml
index ef87110..9356aca 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -14,6 +14,7 @@
14 templates: 14 templates:
15 - openstack-python36-jobs 15 - openstack-python36-jobs
16 - openstack-cover-jobs 16 - openstack-cover-jobs
17 - release-notes-jobs-python3
17 check: 18 check:
18 jobs: 19 jobs:
19 - openstack-tox-pep8 20 - openstack-tox-pep8
diff --git a/doc/requirements.txt b/doc/requirements.txt
index d3cd9da..0f8bf5c 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -3,7 +3,12 @@
3# process, which may cause wedges in the gate later. 3# process, which may cause wedges in the gate later.
4 4
5# Documentation 5# Documentation
6sphinx>=1.6.2 6sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
7sphinx_rtd_theme==0.2.4 7oslosphinx>=4.7.0 # Apache-2.0
8sphinx_rtd_theme
9
8# UML image generation 10# UML image generation
9plantuml 11plantuml
12
13# Releasenotes
14reno>=2.5.0 # Apache-2.0
diff --git a/doc/source/images/architecture-pegleg.png b/doc/source/images/architecture-pegleg.png
index 85428fb..8b526cc 100644
--- a/doc/source/images/architecture-pegleg.png
+++ b/doc/source/images/architecture-pegleg.png
Binary files differ
diff --git a/releasenotes/notes/.placeholder b/releasenotes/notes/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/notes/.placeholder
diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/source/_static/.placeholder
diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/releasenotes/source/_templates/.placeholder
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
new file mode 100644
index 0000000..9c1dcff
--- /dev/null
+++ b/releasenotes/source/conf.py
@@ -0,0 +1,174 @@
1# -*- coding: utf-8 -*-
2#
3# Configuration file for the Sphinx documentation builder.
4#
5# This file does only contain a selection of the most common options. For a
6# full list see the documentation:
7# http://www.sphinx-doc.org/en/master/config
8
9# -- Path setup --------------------------------------------------------------
10
11# If extensions (or modules to document with autodoc) are in another directory,
12# add these directories to sys.path here. If the directory is relative to the
13# documentation root, use os.path.abspath to make it absolute, like shown here.
14#
15# import os
16# import sys
17# sys.path.insert(0, os.path.abspath('.'))
18
19
20# -- Project information -----------------------------------------------------
21
22project = 'pegleg'
23copyright = '2018, Pegleg Authors'
24author = 'Pegleg Authors'
25
26# The short X.Y version
27version = ''
28# The full version, including alpha/beta/rc tags
29release = ''
30
31
32# -- General configuration ---------------------------------------------------
33
34# If your documentation needs a minimal Sphinx version, state it here.
35#
36# needs_sphinx = '1.0'
37
38# Add any Sphinx extension module names here, as strings. They can be
39# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40# ones.
41extensions = [
42 'reno.sphinxext'
43]
44
45# Add any paths that contain templates here, relative to this directory.
46templates_path = ['_templates']
47
48# The suffix(es) of source filenames.
49# You can specify multiple suffix as a list of string:
50#
51# source_suffix = ['.rst', '.md']
52source_suffix = '.rst'
53
54# The master toctree document.
55master_doc = 'index'
56
57# The language for content autogenerated by Sphinx. Refer to documentation
58# for a list of supported languages.
59#
60# This is also used if you do content translation via gettext catalogs.
61# Usually you set "language" from the command line for these cases.
62language = None
63
64# List of patterns, relative to source directory, that match files and
65# directories to ignore when looking for source files.
66# This pattern also affects html_static_path and html_extra_path.
67exclude_patterns = []
68
69# The name of the Pygments (syntax highlighting) style to use.
70pygments_style = None
71
72
73# -- Options for HTML output -------------------------------------------------
74
75# The theme to use for HTML and HTML Help pages. See the documentation for
76# a list of builtin themes.
77#
78html_theme = 'alabaster'
79
80# Theme options are theme-specific and customize the look and feel of a theme
81# further. For a list of options available for each theme, see the
82# documentation.
83#
84# html_theme_options = {}
85
86# Add any paths that contain custom static files (such as style sheets) here,
87# relative to this directory. They are copied after the builtin static files,
88# so a file named "default.css" will overwrite the builtin "default.css".
89html_static_path = ['_static']
90
91# Custom sidebar templates, must be a dictionary that maps document names
92# to template names.
93#
94# The default sidebars (for documents that don't match any pattern) are
95# defined by theme itself. Builtin themes are using these templates by
96# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
97# 'searchbox.html']``.
98#
99# html_sidebars = {}
100
101
102# -- Options for HTMLHelp output ---------------------------------------------
103
104# Output file base name for HTML help builder.
105htmlhelp_basename = 'AirshipPeglegdoc'
106
107
108# -- Options for LaTeX output ------------------------------------------------
109
110latex_elements = {
111 # The paper size ('letterpaper' or 'a4paper').
112 #
113 # 'papersize': 'letterpaper',
114
115 # The font size ('10pt', '11pt' or '12pt').
116 #
117 # 'pointsize': '10pt',
118
119 # Additional stuff for the LaTeX preamble.
120 #
121 # 'preamble': '',
122
123 # Latex figure (float) alignment
124 #
125 # 'figure_align': 'htbp',
126}
127
128# Grouping the document tree into LaTeX files. List of tuples
129# (source start file, target name, title,
130# author, documentclass [howto, manual, or own class]).
131latex_documents = [
132 (master_doc, 'AirshipPegleg.tex', 'Airship Pegleg Documentation',
133 'Airship Authors', 'manual'),
134]
135
136
137# -- Options for manual page output ------------------------------------------
138
139# One entry per manual page. List of tuples
140# (source start file, name, description, authors, manual section).
141man_pages = [
142 (master_doc, 'airshippegleg', 'Airship Pegleg Documentation',
143 [author], 1)
144]
145
146
147# -- Options for Texinfo output ----------------------------------------------
148
149# Grouping the document tree into Texinfo files. List of tuples
150# (source start file, target name, title, author,
151# dir menu entry, description, category)
152texinfo_documents = [
153 (master_doc, 'AirshipPegleg', 'Airship Pegleg Documentation',
154 author, 'AirshipPegleg', 'One line description of project.',
155 'Miscellaneous'),
156]
157
158
159# -- Options for Epub output -------------------------------------------------
160
161# Bibliographic Dublin Core info.
162epub_title = project
163
164# The unique identifier of the text. This can be a ISBN number
165# or the project homepage.
166#
167# epub_identifier = ''
168
169# A unique identification for the text.
170#
171# epub_uid = ''
172
173# A list of files that should not be packed into the epub file.
174epub_exclude_files = ['search.html']
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
new file mode 100644
index 0000000..c34dd6d
--- /dev/null
+++ b/releasenotes/source/index.rst
@@ -0,0 +1,7 @@
1Pegleg Release Notes
2======================
3
4.. toctree::
5 :maxdepth: 1
6
7 unreleased
diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst
new file mode 100644
index 0000000..875030f
--- /dev/null
+++ b/releasenotes/source/unreleased.rst
@@ -0,0 +1,5 @@
1============================
2Current Series Release Notes
3============================
4
5.. release-notes::
diff --git a/tox.ini b/tox.ini
index 070a0d9..53f825b 100644
--- a/tox.ini
+++ b/tox.ini
@@ -59,6 +59,15 @@ deps =
59commands = 59commands =
60 pytest --cov=pegleg --cov-report html:cover --cov-report xml:cover/coverage.xml --cov-report term --cov-fail-under 84 tests/ 60 pytest --cov=pegleg --cov-report html:cover --cov-report xml:cover/coverage.xml --cov-report term --cov-fail-under 84 tests/
61 61
62[testenv:releasenotes]
63basepython = python3
64deps = -r{toxinidir}/doc/requirements.txt
65commands =
66 rm -rf releasenotes/build
67 sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
68whitelist_externals =
69 rm
70
62[testenv:venv] 71[testenv:venv]
63commands = {posargs} 72commands = {posargs}
64 73