From 627e8117efc14f4571c934ba79b6fb027b409b71 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Sun, 23 Feb 2020 15:47:48 +0100 Subject: [PATCH] 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 --- doc/source/conf.py | 18 +----------------- doc/source/index.rst | 1 + setup.cfg | 8 -------- tools/generate-grenade-plugins-list.py | 8 ++++---- tox.ini | 3 +-- 5 files changed, 7 insertions(+), 31 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 6866ee92..e0b53d9c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -97,7 +97,7 @@ man_pages = [] # The theme to use for HTML and HTML Help pages. See the documentation for # 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 # further. For a list of options available for each theme, see the @@ -123,11 +123,6 @@ html_theme = 'nature' # pixels large. #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 # typographically correct entities. #html_use_smartypants = True @@ -171,17 +166,6 @@ htmlhelp_basename = 'Grenade-doc' # -- 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 # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ diff --git a/doc/source/index.rst b/doc/source/index.rst index d90bdae9..e3dcba20 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,3 +1,4 @@ +=================================================== Grenade - an OpenStack Community Upgrade Production =================================================== diff --git a/setup.cfg b/setup.cfg index b48c0780..ade9f5df 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,13 +10,5 @@ classifier = License :: OSI Approved :: Apache Software License Operating System :: POSIX :: Linux -[build_sphinx] -all_files = 1 -build-dir = doc/build -source-dir = doc/source - -[pbr] -warnerrors = True - [wheel] universal = 1 diff --git a/tools/generate-grenade-plugins-list.py b/tools/generate-grenade-plugins-list.py index 714f61a4..a0743041 100644 --- a/tools/generate-grenade-plugins-list.py +++ b/tools/generate-grenade-plugins-list.py @@ -19,9 +19,9 @@ # # In order to function correctly, the environment in which the # script runs must have -# * network access to the review.openstack.org Gerrit API +# * network access to the review.opendev.org Gerrit API # working directory -# * network access to https://git.openstack.org/cgit +# * network access to https://opendev.org/ import json try: @@ -33,7 +33,7 @@ except ImportError: import urllib2 as urllib from urllib2 import HTTPError -url = 'https://review.openstack.org/projects/' +url = 'https://review.opendev.org/projects/' # This is what a project looks like ''' @@ -50,7 +50,7 @@ def is_in_openstack_namespace(proj): def has_grenade_plugin(proj): try: 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 except HTTPError as err: if err.code == 404: diff --git a/tox.ini b/tox.ini index 0ea15e49..f268a7d7 100644 --- a/tox.ini +++ b/tox.ini @@ -29,6 +29,5 @@ setenv = TOP_DIR={toxinidir} INSTALL_SHOCCO=true commands = - # TODO(efried): Use sphinx-build - python setup.py build_sphinx + sphinx-build -W -b html doc/source doc/build/html bash tools/build_docs.sh