Switch docs theme to versioned RTD
To match change I2870450ffd02f55509fcc1297d050b09deafbfb9 in Zuul. Change-Id: Ic23dcbc743ca1c79bcead8eebd2899c00e0750c6
This commit is contained in:
James E. Blair
parent
f58c596eae
commit
202ca394fb
2
doc/requirements.txt
Normal file
2
doc/requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
sphinx_rtd_theme
|
||||||
|
reno>=2.8.0 # Apache-2.0
|
||||||
@ -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>
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.5 KiB After Width: | Height: | Size: 3.2 KiB |
15
doc/source/_templates/versions.html
Normal file
15
doc/source/_templates/versions.html
Normal 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>
|
||||||
@ -12,8 +12,13 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
import os
|
import sys, os, datetime
|
||||||
import sys
|
import subprocess
|
||||||
|
import re
|
||||||
|
from zuul_sphinx import version
|
||||||
|
|
||||||
|
# The minimum version to link to
|
||||||
|
min_version = (0, 4, 0)
|
||||||
|
|
||||||
sys.path.insert(0, os.path.abspath('../..'))
|
sys.path.insert(0, os.path.abspath('../..'))
|
||||||
# -- General configuration ----------------------------------------------------
|
# -- General configuration ----------------------------------------------------
|
||||||
@ -22,8 +27,9 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
|
||||||
'zuul_sphinx',
|
'zuul_sphinx',
|
||||||
|
'reno.sphinxext',
|
||||||
|
'sphinx_rtd_theme',
|
||||||
]
|
]
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
@ -39,8 +45,10 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'zuul-sphinx'
|
project = u'Zuul-Sphinx'
|
||||||
copyright = u'2017, Zuul contributors'
|
copyright = u'2012-%s, Zuul project contributors' % datetime.date.today().year
|
||||||
|
|
||||||
|
doc_root = os.environ.get('ZUUL_DOC_ROOT', '/docs/%s' % (project.lower()))
|
||||||
|
|
||||||
# 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
|
||||||
@ -56,9 +64,65 @@ pygments_style = 'sphinx'
|
|||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||||
# html_theme_path = ["."]
|
html_theme = "sphinx_rtd_theme"
|
||||||
# html_theme = '_theme'
|
|
||||||
# html_static_path = ['static']
|
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}/')]
|
||||||
|
|
||||||
|
try:
|
||||||
|
output = subprocess.check_output(['git', 'tag']).decode('utf8')
|
||||||
|
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
|
||||||
|
# further. For a list of options available for each theme, see the
|
||||||
|
# documentation.
|
||||||
|
html_theme_options = {
|
||||||
|
'collapse_navigation': False,
|
||||||
|
'navigation_depth': -1,
|
||||||
|
'logo_only': True,
|
||||||
|
}
|
||||||
|
|
||||||
|
html_context = {
|
||||||
|
# This controls what is displayed at the top of the navbar.
|
||||||
|
'version': version,
|
||||||
|
# This controls what the caret selection displays at the bottom of
|
||||||
|
# the navbar.
|
||||||
|
'current_version': current_version,
|
||||||
|
# A tuple of (slug, url)
|
||||||
|
'versions': versions,
|
||||||
|
}
|
||||||
|
|
||||||
|
# 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 paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ['_templates']
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to place at the top
|
||||||
|
# of the sidebar.
|
||||||
|
html_logo = '_static/logo.svg'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
@ -70,25 +134,16 @@ latex_documents = [
|
|||||||
('index',
|
('index',
|
||||||
'%s.tex' % project,
|
'%s.tex' % project,
|
||||||
u'%s Documentation' % project,
|
u'%s Documentation' % project,
|
||||||
u'OpenStack Foundation', 'manual'),
|
u'Zuul contributors', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Example configuration for intersphinx: refer to the Python standard library.
|
# Example configuration for intersphinx: refer to the Python standard library.
|
||||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
#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
|
# 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
|
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
# pixels large.
|
# pixels large.
|
||||||
#html_favicon = None
|
#html_favicon = None
|
||||||
|
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Additional Zuul role paths
|
||||||
# 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']
|
|
||||||
|
|
||||||
# Sample additional role paths
|
|
||||||
zuul_role_paths = ['tests/roles']
|
zuul_role_paths = ['tests/roles']
|
||||||
|
|||||||
5
tox.ini
5
tox.ini
@ -20,10 +20,13 @@ deps = bindep
|
|||||||
commands = bindep test
|
commands = bindep test
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
|
usedevelop = True
|
||||||
|
deps =
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
|
-r{toxinidir}/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
sphinx-build -E -W -d doc/build/doctrees -b html doc/source/ doc/build/html
|
sphinx-build -E -W -d doc/build/doctrees -b html doc/source/ doc/build/html
|
||||||
|
|
||||||
|
|
||||||
[testenv:pep8]
|
[testenv:pep8]
|
||||||
whitelist_externals = bash
|
whitelist_externals = bash
|
||||||
commands =
|
commands =
|
||||||
|
|||||||
32
zuul_sphinx/version.py
Normal file
32
zuul_sphinx/version.py
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
# Copyright 2020 Red Hat, inc
|
||||||
|
#
|
||||||
|
# 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 json
|
||||||
|
|
||||||
|
import pbr.version
|
||||||
|
import pkg_resources
|
||||||
|
|
||||||
|
version_info = pbr.version.VersionInfo('zuul-sphinx')
|
||||||
|
release_string = version_info.release_string()
|
||||||
|
|
||||||
|
is_release = None
|
||||||
|
git_version = None
|
||||||
|
try:
|
||||||
|
_metadata = json.loads(
|
||||||
|
pkg_resources.get_distribution('zuul-sphinx').get_metadata('pbr.json'))
|
||||||
|
if _metadata:
|
||||||
|
is_release = _metadata['is_release']
|
||||||
|
git_version = _metadata['git_version']
|
||||||
|
except Exception:
|
||||||
|
pass
|
||||||
Loading…
Reference in New Issue
Block a user