Cleanup docs building

* Remove settings that openstackdocstheme now defaults to.
* Switch completly to openstackdocstheme to be in sync with
  other OpenStack projects.
* Use sphinx-build.
* Change tools/generate-grenade-plugins-list.py to use opendev URLs.

Change-Id: Ic6dd19d8695f4d8db6655e7cac7a6eb7736cd4c1
This commit is contained in:
Andreas Jaeger 2020-02-23 15:47:48 +01:00
parent 1a08c4416d
commit 627e8117ef
5 changed files with 7 additions and 31 deletions

View File

@ -97,7 +97,7 @@ man_pages = []
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'nature' html_theme = 'openstackdocs'
# 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
@ -123,11 +123,6 @@ html_theme = 'nature'
# pixels large. # pixels large.
#html_favicon = None #html_favicon = None
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
html_last_updated_fmt = os.popen(git_cmd).read()
# If true, SmartyPants will be used to convert quotes and dashes to # If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities. # typographically correct entities.
#html_use_smartypants = True #html_use_smartypants = True
@ -171,17 +166,6 @@ htmlhelp_basename = 'Grenade-doc'
# -- Options for LaTeX output -------------------------------------------------- # -- 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 = [

View File

@ -1,3 +1,4 @@
===================================================
Grenade - an OpenStack Community Upgrade Production Grenade - an OpenStack Community Upgrade Production
=================================================== ===================================================

View File

@ -10,13 +10,5 @@ classifier =
License :: OSI Approved :: Apache Software License License :: OSI Approved :: Apache Software License
Operating System :: POSIX :: Linux Operating System :: POSIX :: Linux
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
[pbr]
warnerrors = True
[wheel] [wheel]
universal = 1 universal = 1

View File

@ -19,9 +19,9 @@
# #
# In order to function correctly, the environment in which the # In order to function correctly, the environment in which the
# script runs must have # script runs must have
# * network access to the review.openstack.org Gerrit API # * network access to the review.opendev.org Gerrit API
# working directory # working directory
# * network access to https://git.openstack.org/cgit # * network access to https://opendev.org/
import json import json
try: try:
@ -33,7 +33,7 @@ except ImportError:
import urllib2 as urllib import urllib2 as urllib
from urllib2 import HTTPError from urllib2 import HTTPError
url = 'https://review.openstack.org/projects/' url = 'https://review.opendev.org/projects/'
# This is what a project looks like # This is what a project looks like
''' '''
@ -50,7 +50,7 @@ def is_in_openstack_namespace(proj):
def has_grenade_plugin(proj): def has_grenade_plugin(proj):
try: try:
r = urllib.urlopen( r = urllib.urlopen(
"https://git.openstack.org/cgit/%s/plain/devstack/upgrade/upgrade.sh" % proj) "https://opendev.org/%s/src/branch/master/devstack/upgrade/upgrade.sh" % proj)
return True return True
except HTTPError as err: except HTTPError as err:
if err.code == 404: if err.code == 404:

View File

@ -29,6 +29,5 @@ setenv =
TOP_DIR={toxinidir} TOP_DIR={toxinidir}
INSTALL_SHOCCO=true INSTALL_SHOCCO=true
commands = commands =
# TODO(efried): Use sphinx-build sphinx-build -W -b html doc/source doc/build/html
python setup.py build_sphinx
bash tools/build_docs.sh bash tools/build_docs.sh