Switch to newer openstackdocstheme and reno versions

Code Issues Proposed changes

Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
Disable openstackdocs_auto_name to use 'project' variable as name.
Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.
Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I131850d2a5c6164dfd48c9c95885d4754b5236c6

This commit is contained in:

Andreas Jaeger

2020年06月02日 18:53:59 +02:00

parent 019bade19c

commit 3d105b623d

5 changed files with 21 additions and 73 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt

View File

@@ -2,9 +2,9 @@

# of appearance. Changing the order has an impact on the overall integration

# process, which may cause wedges in the gate later.

# this is required for the docs build jobs

sphinx>=1.6.2 # BSD

openstackdocstheme>=1.30.0 # Apache-2.0

reno>=1.8.0 # Apache-2.0

sphinx>=2.0.0,!=2.1.0 # BSD

openstackdocstheme>=2.2.1 # Apache-2.0

reno>=3.1.0 # Apache-2.0

os-api-ref>=1.0.0 # Apache-2.0

python-keystoneclient!=2.1.0,>=2.0.0 # Apache-2.0

sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

25
doc/source/conf.py

View File

@@ -29,7 +29,6 @@

import datetime

import logging

import os

from swift import __version__

import sys

# NOTE(amotoki): Our current doc build job uses an older version of

@@ -80,15 +79,6 @@ else:

now = datetime.date.today()

copyright = u'%d, OpenStack Foundation' % now.year

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

#

# The short X.Y version.

version = __version__.rsplit('.', 1)[0]

# The full version, including alpha/beta/rc tags.

release = __version__

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# language = None

@@ -122,7 +112,7 @@ exclude_trees = []

show_authors = True

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

pygments_style = 'native'

# A list of ignored prefixes for module index sorting.

modindex_common_prefix = ['swift.']

@@ -172,11 +162,6 @@ html_theme_options = {

# robots.txt.

html_extra_path = ['_extra']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

# using the given strftime format.

# html_last_updated_fmt = '%b %d, %Y'

html_last_updated_fmt = '%Y-%m-%d%H:%M'

# If true, SmartyPants will be used to convert quotes and dashes to

# typographically correct entities.

# html_use_smartypants = True

@@ -248,6 +233,8 @@ latex_documents = [

latex_use_xindy = False

# -- Options for openstackdocstheme -------------------------------------------

repository_name = 'openstack/swift'

bug_project = 'swift'

bug_tag = ''

openstackdocs_repo_name = 'openstack/swift'

openstackdocs_pdf_link = True

openstackdocs_auto_name = False

openstackdocs_bug_project = 'swift'

openstackdocs_bug_tag = ''