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. 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. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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: I15963b7399cfd8dbd7d3c1def8b5c13dae323ae6
This commit is contained in:
parent
7c859a4fd6
commit
968395a4b0
|
@ -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.
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=2.0.0 # Apache-2.0
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
sphinxcontrib-pecanwsme>=0.10.0 # Apache-2.0
|
||||
sphinxcontrib-httpdomain>=1.6.1 # BSD
|
||||
reno>=2.7.0 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
|
||||
|
|
|
@ -53,7 +53,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 --------------------------------------------------
|
||||
|
||||
|
@ -65,12 +65,11 @@ html_theme = 'openstackdocs'
|
|||
html_static_path = ['_static']
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/solum'
|
||||
bug_project = 'solum'
|
||||
bug_tag = ''
|
||||
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
openstackdocs_repo_name = 'openstack/solum'
|
||||
openstackdocs_pdf_link = True
|
||||
openstackdocs_auto_name = False
|
||||
openstackdocs_bug_project = 'solum'
|
||||
openstackdocs_bug_tag = ''
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
|
|
@ -56,7 +56,6 @@ munch==2.2.0
|
|||
netaddr==0.7.19
|
||||
netifaces==0.10.6
|
||||
nose==1.3.7
|
||||
openstackdocstheme==2.0.0
|
||||
openstacksdk==0.12.0
|
||||
os-client-config==1.29.0
|
||||
os-service-types==1.2.0
|
||||
|
@ -108,7 +107,6 @@ python-swiftclient==3.5.0
|
|||
python-zaqarclient==1.9.0
|
||||
pytz==2018.3
|
||||
PyYAML==3.12
|
||||
reno==2.7.0
|
||||
repoze.lru==0.7
|
||||
requests==2.18.4
|
||||
requestsexceptions==1.4.0
|
||||
|
@ -117,10 +115,6 @@ Routes==2.4.1
|
|||
simplegeneric==0.8.1
|
||||
simplejson==3.13.2
|
||||
snowballstemmer==1.2.1
|
||||
Sphinx==2.0.0
|
||||
sphinxcontrib-httpdomain==1.6.1
|
||||
sphinxcontrib-pecanwsme==0.10.0
|
||||
sphinxcontrib-websupport==1.0.1
|
||||
SQLAlchemy==1.2.5
|
||||
sqlalchemy-migrate==0.11.0
|
||||
sqlparse==0.2.4
|
||||
|
|
|
@ -98,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 = []
|
||||
|
@ -192,9 +192,10 @@ html_static_path = ['_static']
|
|||
htmlhelp_basename = 'SolumReleaseNotesdoc'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/solum'
|
||||
bug_project = 'solum'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/solum'
|
||||
openstackdocs_auto_name = False
|
||||
openstackdocs_bug_project = 'solum'
|
||||
openstackdocs_bug_tag = ''
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
|
|
Loading…
Reference in New Issue