openstack/osprofiler
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.

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: Ia700e656b4c2616ccbff32707eb4297a1dafbe3b
This commit is contained in:
Andreas Jaeger 2020-06-02 13:36:43 +02:00
parent c4c57a1680
commit c568c9f769
4 changed files with 16 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/conf.py
View File

@ -40,9 +40,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/osprofiler'
bug_project = 'osprofiler'
bug_tag = ''
openstackdocs_repo_name = 'openstack/osprofiler'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'osprofiler'
openstackdocs_bug_tag = ''
todo_include_todos = True
@ -91,7 +92,7 @@ add_module_names = True
#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 = []
@ -132,10 +133,6 @@ html_theme = 'openstackdocs'
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_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

6
lower-constraints.txt
View File

@ -5,7 +5,7 @@ elasticsearch===2.0.0
jaeger-client==3.8.0
mock===2.0.0
netaddr===0.7.18
openstackdocstheme===1.18.1
openstackdocstheme==2.2.1
oslo.concurrency===3.26.0
oslo.config===5.2.0
oslo.serialization===2.18.0
@ -13,10 +13,10 @@ oslo.utils===3.33.0
PrettyTable===0.7.2
pymongo===3.0.2
redis===2.10.0
reno===2.5.0
reno==3.1.0
requests===2.14.2
six===1.10.0
sphinx===1.6.2
Sphinx===2.0.0
stestr==2.0.0
testtools===2.2.0
WebOb===1.7.1

10
releasenotes/source/conf.py
View File

@ -40,9 +40,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/osprofiler'
bug_project = 'osprofiler'
bug_tag = ''
openstackdocs_repo_name = 'openstack/osprofiler'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'osprofiler'
openstackdocs_bug_tag = ''
# 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 = []
@ -148,7 +149,6 @@ html_static_path = ['_static']
# 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.

6
test-requirements.txt
View File

@ -6,8 +6,8 @@ ddt>=1.0.1 # MIT
stestr>=2.0.0 # Apache-2.0
testtools>=2.2.0 # MIT
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
# Bandit security code scanner
bandit>=1.1.0 # Apache-2.0
@ -21,7 +21,7 @@ elasticsearch>=2.0.0,<3.0.0 # Apache-2.0
redis>=2.10.0 # MIT
# Build release notes
reno>=2.5.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
# For Jaeger Tracing
jaeger-client>=3.8.0 # Apache-2.0