openstack/masakari-monitors
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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.

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: I4d11b986ed6ce54fbc2b08234c061041099b709e
This commit is contained in:
Andreas Jaeger 2020-05-31 18:02:43 +02:00
parent be1173e853
commit 3e93eab356
5 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/requirements.txt
View File

@ -2,7 +2,7 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
# releasenotes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0

5
doc/source/conf.py
View File

@ -47,7 +47,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 --------------------------------------------------
@ -57,7 +57,8 @@ pygments_style = 'sphinx'
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs'
repository_name ='openstack/masakari-monitors'
openstackdocs_repo_name ='openstack/masakari-monitors'
openstackdocs_bug_project = 'masakari-monitors'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project

4
lower-constraints.txt
View File

@ -44,7 +44,6 @@ munch==2.2.0
netaddr==0.7.19
netifaces==0.10.6
lxml==3.4.1
openstackdocstheme==2.0.0
openstacksdk==0.13.0
os-client-config==1.29.0
os-service-types==1.2.0
@ -83,7 +82,6 @@ python-novaclient==10.1.0
python-subunit==1.0.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
repoze.lru==0.7
requests==2.18.4
requestsexceptions==1.4.0
@ -92,8 +90,6 @@ Routes==2.4.1
simplejson==3.13.2
six==1.10.0
snowballstemmer==1.2.1
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
statsd==3.2.2
stestr==2.0.0
stevedore==1.28.0

6
releasenotes/source/conf.py
View File

@ -98,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 = []
@ -112,7 +112,9 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'openstackdocs'
repository_name = 'openstack/masakari-monitors'
openstackdocs_repo_name = 'openstack/masakari-monitors'
openstackdocs_bug_project = 'masakari-monitors'
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

4
test-requirements.txt
View File

@ -6,13 +6,9 @@ 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>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.0.0 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0
os-testr>=1.0.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
ddt>=1.0.1 # MIT
# releasenotes
reno>=2.5.0 # Apache-2.0