openstack/blazar-dashboard
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.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

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: I882ab18020ee8a15a3204e72d1bf68f4d5195b14
This commit is contained in:
Andreas Jaeger 2020-05-21 20:18:09 +02:00
parent 98944bf7d6
commit d249b802be
3 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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.
openstackdocstheme>=1.31.2 # Apache-2.0
sphinx>=1.8.0,!=2.1.0 # 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
sphinxcontrib-httpdomain>=1.3.0 # BSD

10
doc/source/conf.py
View File

@ -35,9 +35,11 @@ extensions = ['sphinx.ext.autodoc',
]
# openstackdocstheme options
repository_name = 'openstack/blazar-dashboard'
bug_project = 'blazar'
bug_tag = ''
openstackdocs_repo_name = 'openstack/blazar-dashboard'
openstackdocs_pdf_link = True
openstackdocs_auto_name = False
openstackdocs_bug_project = 'blazar'
openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -85,7 +87,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 = []

9
releasenotes/source/conf.py
View File

@ -43,9 +43,10 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/blazar-dashboard'
bug_project = 'blazar'
bug_tag = ''
openstackdocs_repo_name = 'openstack/blazar-dashboard'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'blazar'
openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']
@ -99,7 +100,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 = []