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

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.

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: Ic3745264cee3515683dfe028014203388e735fdd
This commit is contained in:
Andreas Jaeger 2020-05-21 14:19:33 +02:00
parent a62aaabaac
commit d86bc73d35
3 changed files with 12 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,8 +2,8 @@
# 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
reno>=2.5.0 # Apache2
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-httpdomain
sphinxcontrib-pecanwsme>=0.10.0

9
doc/source/conf.py
View File

@ -107,7 +107,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#', '**/*alembic*']
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,9 +148,10 @@ html_theme = 'openstackdocs'
html_static_path = ['_static']
# openstackdocstheme options
repository_name = 'openstack/aodh'
bug_project = 'aodh'
bug_tag = ''
openstackdocs_repo_name = 'openstack/aodh'
openstackdocs_pdf_link = True
openstackdocs_bug_project = 'aodh'
openstackdocs_bug_tag = ''
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

8
releasenotes/source/conf.py
View File

@ -87,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 = []
@ -137,9 +137,9 @@ html_static_path = ['_static']
# html_extra_path = []
# openstackdocstheme options
repository_name = 'openstack/aodh'
bug_project = 'aodh'
bug_tag = ''
openstackdocs_repo_name = 'openstack/aodh'
openstackdocs_bug_project = 'aodh'
openstackdocs_bug_tag = ''
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.