openstack
/
qinling-dashboard
Code Issues Proposed changes

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: Ib1e0a744a05cab9470366d81e0f9228fc8fc136e
This commit is contained in:
Andreas Jaeger 2020-06-01 15:30:43 +02:00
parent d35109723a
commit a118f06dae
3 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/requirements.txt
View File

@ -6,9 +6,9 @@
# added in alphabetical order, however, some dependencies may need to
# be installed in a specific order.
#
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

10
doc/source/conf.py
View File

@ -42,10 +42,10 @@ project = u'Qinling Dashboard'
copyright = u'2017, OpenStack Developers'
# openstackdocstheme options
repository_name = 'openstack/qinling-dashboard'
bug_project = '927'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/qinling-dashboard'
openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@ -55,7 +55,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 --------------------------------------------------

9
releasenotes/source/conf.py
View File

@ -56,10 +56,9 @@ project = u'Qinling Dashboard Release Notes'
copyright = u'2017, OpenStack Foundation'
# openstackdocstheme options
repository_name = 'openstack/qinling-dashboard'
bug_project = 'qinling-dashboard'
bug_tag = 'doc'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
openstackdocs_repo_name = 'openstack/qinling-dashboard'
openstackdocs_auto_name = False
openstackdocs_use_storyboard = True
# Release notes are version independent, no need to set version and release
release = ''
@ -95,7 +94,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 = []