Switch to newer openstackdocstheme and reno versions

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.

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.

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: I6974f7131d7ac43b427f8ac6381aff80b9dcb884
This commit is contained in:
Andreas Jaeger 2020-05-26 08:55:54 +02:00
parent 266192b11b
commit d5bc18e320
4 changed files with 16 additions and 19 deletions

View File

@ -29,9 +29,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/debtcollector'
bug_project = 'debtcollector'
bug_tag = 'doc'
openstackdocs_repo_name = 'openstack/debtcollector'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'debtcollector'
openstackdocs_bug_tag = 'doc'
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@ -55,7 +56,7 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------
@ -66,7 +67,6 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# html_static_path = ['static']
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

View File

@ -14,7 +14,7 @@ Jinja2==2.10
linecache2==1.0.0
MarkupSafe==1.0
mccabe==0.2.1
openstackdocstheme==1.18.1
openstackdocstheme==2.2.1
pbr==2.0.0
pep8==1.5.7
pyflakes==0.8.1
@ -23,12 +23,12 @@ python-mimeparse==1.6.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
reno==3.1.0
requests==2.14.2
restructuredtext-lint==1.1.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.5
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
stevedore==1.20.0
stestr==2.0.0

View File

@ -40,9 +40,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/debtcollector'
bug_project = 'debtcollector'
bug_tag = 'doc'
openstackdocs_repo_name = 'openstack/debtcollector'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'debtcollector'
openstackdocs_bug_tag = 'doc'
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -97,7 +98,7 @@ exclude_patterns = []
# show_authors = False
# 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 = []
@ -146,10 +147,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
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

View File

@ -6,10 +6,10 @@ hacking>=3.0,<3.1.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
python-subunit>=1.0.0 # Apache-2.0/BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
testtools>=2.2.0 # MIT
fixtures>=3.0.0 # Apache-2.0/BSD
doc8>=0.6.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0