openstack
/
telemetry-specs
Code Issues Proposed changes

Switch to newer openstackdocstheme version 

Switch to openstackdocstheme 2.2.1 version. Using
this version 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: I663d89c5ac0bc7c6bedd576ab82af4f4d66055ea
This commit is contained in:
Andreas Jaeger 2020-06-02 13:57:56 +02:00
parent ac82cef15a
commit 039cfd4854
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/conf.py
View File

@ -25,8 +25,8 @@ extensions = [
] ]
# Feed configuration for yasfb # Feed configuration for yasfb
feed_base_url = 'http://specs.openstack.org/openstack/ceilometer-specs' feed_base_url = 'https://specs.openstack.org/openstack/telemetry-specs'
feed_author = 'OpenStack Ceilometer Team' feed_author = 'OpenStack Telemetry Team'
exclude_patterns = [ exclude_patterns = [
'template.rst', 'template.rst',
@ -48,8 +48,9 @@ project = u'telemetry-specs'
copyright = u'%s, OpenStack Foundation' % datetime.date.today().year copyright = u'%s, OpenStack Foundation' % datetime.date.today().year
# openstackdocstheme options # openstackdocstheme options
repository_name = 'openstack/telemetry-specs' openstackdocs_repo_name = 'openstack/telemetry-specs'
use_storyboard = True openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
html_theme = 'openstackdocs' html_theme = 'openstackdocs'
# If true, '()' will be appended to :func: etc. cross-reference text. # If true, '()' will be appended to :func: etc. cross-reference text.
@ -60,7 +61,7 @@ add_function_parentheses = True
add_module_names = True add_module_names = True
# The name of the Pygments (syntax highlighting) style to use. # The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx' pygments_style = 'native'
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------

4
requirements.txt
View File

@ -1,6 +1,6 @@
pbr!=2.1.0,>=2.0.0 # Apache-2.0 pbr!=2.1.0,>=2.0.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.5 # BSD sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=1.32.1 openstackdocstheme>=2.2.1 # Apache-2.0
testrepository>=0.0.18 testrepository>=0.0.18
testtools>=0.9.34 testtools>=0.9.34
yasfb>=0.5.1 yasfb>=0.5.1