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.

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.

Set openstackdocs_auto_name to use 'project' 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.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I51fea3e1e954fd8fce782025d00aaf9dc396a68d
This commit is contained in:
Andreas Jaeger 2020-05-18 22:45:41 +02:00 committed by Andreas Jaeger
parent 368e9fb7a4
commit 3fb93d566a
4 changed files with 12 additions and 28 deletions

View File

@ -1,6 +1,6 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
reno>=3.1.0 # Apache-2.0

View File

@ -35,10 +35,9 @@ source_suffix = '.rst'
master_doc = 'index'
# openstackdocstheme options
repository_name = 'openstack/python-senlinclient'
bug_project = 'python-senlinclient'
bug_tag = ''
project = 'python-senlinclient'
openstackdocs_repo_name = 'openstack/python-senlinclient'
openstackdocs_bug_project = 'python-senlinclient'
openstackdocs_bug_tag = ''
copyright = 'OpenStack Contributors'
# List of directories, relative to source directory, that shouldn't be searched
@ -53,7 +52,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 --------------------------------------------------
@ -61,12 +60,6 @@ pygments_style = 'sphinx'
# Sphinx are currently 'default' and 'sphinxdoc'.
html_theme = 'openstackdocs'
# -- Options for openstackdocstheme -------------------------------------------
repository_name = 'openstack/python-senlinclient'
bug_project = 'python-senlinclient'
bug_tag = ''
# -- Options for manual page output ------------------------------------------
# One entry per manual page. List of tuples
@ -75,6 +68,3 @@ man_pages = [
('index', 'senlin', 'OpenStack Senlin command line client',
['OpenStack Contributors'], 1),
]
# Last updated
html_last_updated_fmt = '%Y-%m-%d %H:%M'

View File

@ -38,7 +38,6 @@ msgpack-python==0.4.0
munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.18.1
openstacksdk==0.24.0
os-client-config==1.28.0
os-service-types==1.2.0
@ -77,7 +76,6 @@ python-subunit==1.0.0
python-swiftclient==3.2.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
requests==2.14.2
requests-mock==1.2.0
requestsexceptions==1.2.0
@ -86,8 +84,6 @@ setuptools==21.0.0
simplejson==3.5.1
six==1.10.0
snowballstemmer==1.2.1
Sphinx==1.6.5
sphinxcontrib-websupport==1.0.1
stestr==2.0.0
stevedore==1.20.0
tempest==17.1.0

View File

@ -93,7 +93,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 = []
@ -109,9 +109,10 @@ pygments_style = 'sphinx'
html_theme = 'openstackdocs'
# openstackdocstheme options
repository_name = 'openstack/python-senlinclient'
bug_project = 'python-senlinclient'
bug_tag = ''
openstackdocs_repo_name = 'openstack/python-senlinclient'
openstackdocs_bug_project = 'python-senlinclient'
openstackdocs_bug_tag = ''
openstackdocs_auto_name = False
# 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
@ -147,9 +148,6 @@ html_static_path = ['_static']
# directly to the root of the documentation.
# html_extra_path = []
# Must set this variable to include year, month, day, hours, and minutes.
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