zuul/nodepool
Code Issues Proposed changes

Switch docs theme to versioned RTD

Browse Source 
To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul.

The default domain is changed to zuul which uncovered a reference
error which is fixed.

Change-Id: I71db35252d018feed41d9e87aa702c6daa61902b
This commit is contained in:
James E. Blair 2021-12-15 13:30:48 -08:00
parent a94a8933bc
commit e95b146d10
7 changed files with 218 additions and 215 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/requirements.txt
View File

@ -3,3 +3,4 @@ sphinxcontrib-programoutput
sphinxcontrib-httpdomain sphinxcontrib-httpdomain
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
zuul-sphinx>=0.3.0 zuul-sphinx>=0.3.0
sphinx_rtd_theme

100
doc/source/_static/logo.svg
View File

@ -1,22 +1,86 @@
<?xml version="1.0" encoding="utf-8"?> <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Generator: Adobe Illustrator 22.0.1, SVG Export Plug-In . SVG Version: 6.00 Build 0) --> <svg
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" xmlns:dc="http://purl.org/dc/elements/1.1/"
viewBox="0 0 144 144" style="enable-background:new 0 0 144 144;" xml:space="preserve"> xmlns:cc="http://creativecommons.org/ns#"
<style type="text/css"> xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
id="Layer_1"
x="0px"
y="0px"
viewBox="0 0 1999.9989 533.33301"
xml:space="preserve"
sodipodi:docname="Zuul_Logo_Full_Horizontal_RGB_DarkBlue.svg"
width="1999.9988"
height="533.33301"
inkscape:version="1.0.2 (e86c870879, 2021-01-15)"><metadata
id="metadata1646"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title></dc:title></cc:Work></rdf:RDF></metadata><defs
id="defs1644" /><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1983"
inkscape:window-height="845"
id="namedview1642"
showgrid="false"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
inkscape:zoom="0.2545462"
inkscape:cx="107.94999"
inkscape:cy="28.799999"
inkscape:window-x="235"
inkscape:window-y="67"
inkscape:window-maximized="0"
inkscape:current-layer="Layer_1" />
<style
type="text/css"
id="style1625">
.st0{fill:#071D49;} .st0{fill:#071D49;}
</style> </style>
<g> <g
<path class="st0" d="M12.8,102.6h118.5L106,58.8v-15l7-9.2H92L72,0L52,34.7H31.1l7,9.2v15L12.8,102.6z M38,96.6H23.1L38,70.8V96.6z id="g1639"
M48.4,96.6H44V61.3h4.3V96.6z M48.4,55.3H44V51h4.3V55.3z M69,96.6H54.3V61.3H69V96.6z M89.7,96.6H75V61.3h14.7V96.6z M89.7,55.3 transform="matrix(9.2592535,0,0,9.2592535,-316.66647,-399.99975)"
H54.3V51h35.3V55.3z M100,96.6h-4.3V61.3h4.3V96.6z M100,55.3h-4.3V51h4.3V55.3z M106,70.8l14.9,25.8H106V70.8z M72,12l13.1,22.7 style="fill:#ffffff;fill-opacity:1">
H58.9L72,12z M100.9,40.7l-0.9,1.2V45H44v-3.2l-0.9-1.2H100.9z"/> <path
<polygon class="st0" points="138.2,137.3 125.1,137.3 125.1,114.6 119.1,118.1 119.1,137.3 119.1,139.6 119.1,143.3 141.6,143.3 class="st0"
"/> d="m 34.2,100.8 h 66.5 L 86.5,76.2 v -8.4 l 3.9,-5.1 H 78.6 L 67.4,43.2 56.2,62.7 H 44.4 l 3.9,5.1 v 8.4 z M 48.4,97.4 H 40 l 8.4,-14.5 z m 5.7,0 H 51.7 V 77.6 h 2.4 z m 0,-23.1 h -2.4 v -2.4 h 2.4 z M 65.7,97.4 H 57.5 V 77.6 h 8.2 z m 11.6,0 H 69.1 V 77.6 h 8.2 z m 0,-23.1 H 57.5 v -2.4 h 19.8 z m 5.8,23.1 H 80.7 V 77.6 h 2.4 z m 0,-23.1 h -2.4 v -2.4 h 2.4 z m 3.4,8.6 8.4,14.5 h -8.4 z m -19.1,-33 7.4,12.7 H 60 Z M 83.6,66 83.1,66.7 v 1.8 H 51.7 V 66.7 L 51.2,66 Z"
<path class="st0" d="M99.1,131.5L99.1,131.5L99.1,131.5c0,3.6-2.9,6.5-6.5,6.5c-3.6,0-6.5-2.9-6.5-6.5v0h0v-16.9l-6,3.5v13.5v0 id="path1627"
c0,6.9,5.6,12.5,12.5,12.5c6.9,0,12.5-5.6,12.5-12.5v0v-16.9l-6,3.5V131.5z"/> style="fill:#ffffff;fill-opacity:1" />
<path class="st0" d="M60.2,131.5L60.2,131.5L60.2,131.5c0,3.6-2.9,6.5-6.5,6.5c-3.6,0-6.5-2.9-6.5-6.5v0h0v-16.9l-6,3.5v13.5v0 <g
c0,6.9,5.6,12.5,12.5,12.5c6.9,0,12.5-5.6,12.5-12.5v0v-16.9l-6,3.5V131.5z"/> id="g1637"
<polygon class="st0" points="25.8,114.6 25.4,114.6 18.9,114.6 5.8,114.6 2.4,120.6 15.5,120.6 2.4,143.3 23.8,143.3 27.3,137.3 style="fill:#ffffff;fill-opacity:1">
12.7,137.3 "/> <polygon
class="st0"
points="227.5,86 250.2,86 246.7,80 233.5,80 233.5,57.2 227.5,60.7 "
id="polygon1629"
style="fill:#ffffff;fill-opacity:1" />
<path
class="st0"
d="m 207.5,74.2 v 0 0 c 0,3.6 -2.9,6.5 -6.5,6.5 -3.6,0 -6.5,-2.9 -6.5,-6.5 v 0 0 -17 l -6,3.5 v 13.5 0 c 0,6.9 5.6,12.5 12.5,12.5 6.9,0 12.5,-5.6 12.5,-12.5 v 0 -17 l -6,3.5 z"
id="path1631"
style="fill:#ffffff;fill-opacity:1" />
<path
class="st0"
d="m 168.4,74.2 v 0 0 c 0,3.6 -2.9,6.5 -6.5,6.5 -3.6,0 -6.5,-2.9 -6.5,-6.5 v 0 0 -17 l -6,3.5 v 13.5 0 c 0,6.9 5.6,12.5 12.5,12.5 6.9,0 12.5,-5.6 12.5,-12.5 v 0 -17 l -6,3.5 z"
id="path1633"
style="fill:#ffffff;fill-opacity:1" />
<polygon
class="st0"
points="110.4,86 131.9,86 135.4,80 120.8,80 133.9,57.2 113.8,57.2 110.4,63.3 123.5,63.3 "
id="polygon1635"
style="fill:#ffffff;fill-opacity:1" />
</g>
</g> </g>
</svg> </svg>

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 1.5 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

15
doc/source/_templates/versions.html Normal file
View File

@ -0,0 +1,15 @@
{# Based on versions.html from sphinx_rtd_theme, Licensed under ASL2 #}
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="{{ _('Versions') }}">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book">{{ _('Versions') }}</span>
v: {{ current_version }}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
{% for slug, url in versions %}
<dd><a href="{{ url }}">{{ slug }}</a></dd>
{% endfor %}
</dl>
</div>
</div>

276
doc/source/conf.py
View File

@ -1,243 +1,151 @@
# -*- coding: utf-8 -*- # -*- 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
# #
# Nodepool documentation build configuration file, created by # http://www.apache.org/licenses/LICENSE-2.0
# sphinx-quickstart on Fri Jun 8 14:44:26 2012.
# #
# This file is execfile()d with the current directory set to its containing dir. # Unless required by applicable law or agreed to in writing, software
# # distributed under the License is distributed on an "AS IS" BASIS,
# Note that not all possible configuration values are present in this # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# autogenerated file. # implied.
# # See the License for the specific language governing permissions and
# All configuration values have a default; values that are commented out # limitations under the License.
# serve to show the default.
import sys, os, datetime import sys, os, datetime
import subprocess
import re
from nodepool import version
# The minimum version to link to
min_version = (3, 2, 0)
# 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('../..')) sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
# -- 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.
# 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 = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'sphinxcontrib.programoutput', 'sphinxcontrib.programoutput',
'sphinxcontrib.httpdomain', 'sphinxcontrib.httpdomain',
'zuul_sphinx', 'zuul_sphinx',
'reno.sphinxext'] 'reno.sphinxext',
#extensions = ['sphinx.ext.intersphinx'] 'sphinx_rtd_theme',
#intersphinx_mapping = {'python': ('http://docs.python.org/2.7', None)} ]
# Add any paths that contain templates here, relative to this directory. # autodoc generation is a bit aggressive and a nuisance when doing heavy
templates_path = ['_templates'] # text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable
primary_domain = 'zuul'
# The suffix of source filenames. # The suffix of source filenames.
source_suffix = '.rst' source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document. # The master toctree document.
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Nodepool' project = u'Nodepool'
copyright = u'%s, OpenStack' % datetime.date.today().year copyright = u'2012-%s, Zuul project contributors' % datetime.date.today().year
# The language for content autogenerated by Sphinx. Refer to documentation doc_root = os.environ.get('ZUUL_DOC_ROOT', '/docs/%s' % (project.lower()))
# 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. # If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True add_function_parentheses = True
# If true, the current module name will be prepended to all description # If true, the current module name will be prepended to all description
# unit titles (such as .. function::). # unit titles (such as .. function::).
#add_module_names = True 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. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting. # -- Options for HTML output --------------------------------------------------
#modindex_common_prefix = []
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = "sphinx_rtd_theme"
# -- Options for HTML output --------------------------------------------------- if version.is_release:
version = version.release_string
current_version = version.release_string
versions = [('latest', f'{doc_root}/')]
else:
# Uncomment this if we want to use the in-development version
# number (eg 4.10.5.dev4 887cf31e4 )
# version = version.get_version_string()
version = 'latest'
current_version = 'latest'
versions = [('latest', f'{doc_root}/')]
# The theme to use for HTML and HTML Help pages. See the documentation for try:
# a list of builtin themes. output = subprocess.check_output(['git', 'tag']).decode('utf8')
#html_theme = 'alabaster' except subprocess.CalledProcessError:
output = ''
interesting_tags = []
for tag in output.splitlines():
if re.match('^\d+\.\d+\.\d+$', tag):
parts = tuple(map(int, tag.split('.')))
if parts < min_version:
continue
interesting_tags.append((parts, tag))
for parts, tag in reversed(sorted(interesting_tags, key=lambda x: x[0])):
versions.append((tag, f'{doc_root}/{tag}/'))
# Theme options are theme-specific and customize the look and feel of a theme # 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 # further. For a list of options available for each theme, see the
# documentation. # documentation.
html_theme_options = { html_theme_options = {
'show_related': True, 'collapse_navigation': False,
'logo': 'logo.svg', 'navigation_depth': -1,
'logo_only': True,
} }
# Add any paths that contain custom themes here, relative to this directory. html_context = {
#html_theme_path = [] # This controls what is displayed at the top of the navbar.
'version': version,
# The name for this set of Sphinx documents. If None, it defaults to # This controls what the caret selection displays at the bottom of
# "<project> v<release> documentation". # the navbar.
#html_title = None 'current_version': current_version,
# A tuple of (slug, url)
# A shorter title for the navigation bar. Default is the same as html_title. 'versions': versions,
#html_short_title = 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, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # Add any paths that contain templates here, relative to this directory.
# using the given strftime format. templates_path = ['_templates']
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to # The name of an image file (relative to this directory) to place at the top
# typographically correct entities. # of the sidebar.
#html_use_smartypants = True html_logo = '_static/logo.svg'
# 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 <link> 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. # Output file base name for HTML help builder.
htmlhelp_basename = 'Nodepooldoc' htmlhelp_basename = '%sdoc' % project
# -- 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 # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'Nodepool.tex', u'Nodepool Documentation', ('index',
u'OpenStack', 'manual'), '%s.tex' % project,
u'%s Documentation' % project,
u'Zuul contributors', 'manual'),
] ]
# The name of an image file (relative to this directory) to place at the top of # Example configuration for intersphinx: refer to the Python standard library.
# the title page. #intersphinx_mapping = {'http://docs.python.org/': None}
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts, # The name of an image file (within the static path) to use as favicon of the
# not chapters. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
#latex_use_parts = False # pixels large.
#html_favicon = None
# If true, show page references after internal links. # Additional Zuul role paths
#latex_show_pagerefs = False zuul_role_paths = []
# 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', 'nodepool', u'Nodepool Documentation',
[u'OpenStack'], 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', 'Nodepool', u'Nodepool Documentation',
u'OpenStack', 'Nodepool', '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'

2
doc/source/operation.rst
View File

@ -368,7 +368,7 @@ configuration file entirely, if you wish to do so.
Web interface Web interface
------------- -------------
If configured (see :attr:`webapp-conf`), a ``nodepool-launcher`` If configured (see :attr:`webapp`), a ``nodepool-launcher``
instance can provide a range of end-points that can provide instance can provide a range of end-points that can provide
information in text and ``json`` format. Note if there are multiple information in text and ``json`` format. Note if there are multiple
launchers, all will provide the same information. launchers, all will provide the same information.

4
nodepool/driver/__init__.py
View File

@ -131,7 +131,7 @@ class Driver(object, metaclass=abc.ABCMeta):
class ProviderNotifications(object): class ProviderNotifications(object):
""" """
Notification interface for :class:`.Provider` objects. Notification interface for :py:class:`.Provider` objects.
This groups all notification messages bound for the Provider. The This groups all notification messages bound for the Provider. The
Provider class inherits from this by default. A Provider overrides the Provider class inherits from this by default. A Provider overrides the
@ -326,7 +326,7 @@ class LabelRecorder(object):
class NodeRequestHandlerNotifications(object): class NodeRequestHandlerNotifications(object):
""" """
Notification interface for :class:`.NodeRequestHandler` objects. Notification interface for :py:class:`.NodeRequestHandler` objects.
This groups all notification messages bound for the NodeRequestHandler. This groups all notification messages bound for the NodeRequestHandler.
The NodeRequestHandler class inherits from this by default. A request The NodeRequestHandler class inherits from this by default. A request

35
nodepool/version.py
View File

@ -1,17 +1,32 @@
# Copyright 2014 Hewlett-Packard Development Company, L.P. # Copyright 2020 Red Hat, inc
# #
# Licensed under the Apache License, Version 2.0 (the "License"); you may # 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 # not use this file except in compliance with the License. You may obtain
# a copy of the License at # a copy of the License at
# #
# http://www.apache.org/licenses/LICENSE-2.0 # http://www.apache.org/licenses/LICENSE-2.0
# #
# Unless required by applicable law or agreed to in writing, software # Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
import json
import pbr.version import pbr.version
import pkg_resources
version_info = pbr.version.VersionInfo('nodepool') version_info = pbr.version.VersionInfo('nodepool')
release_string = version_info.release_string()
is_release = None
git_version = None
try:
_metadata = json.loads(
pkg_resources.get_distribution('nodepool').get_metadata('pbr.json'))
if _metadata:
is_release = _metadata['is_release']
git_version = _metadata['git_version']
except Exception:
pass