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. 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: I6be1174686cb1d8f11e8cb4be58c0e739bf0f931
This commit is contained in:
parent
65552a84a2
commit
cbcdacac61
|
@ -63,9 +63,9 @@ extensions = ['sphinx.ext.coverage',
|
|||
suppress_warnings = ['app.add_directive']
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/cloudkitty'
|
||||
bug_project = 'cloudkitty'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/cloudkitty'
|
||||
openstackdocs_pdf_link = True
|
||||
openstackdocs_use_storyboard = True
|
||||
|
||||
config_generator_config_file = '../../etc/oslo-config-generator/cloudkitty.conf'
|
||||
policy_generator_config_file = '../../etc/oslo-policy-generator/cloudkitty.conf'
|
||||
|
@ -86,11 +86,6 @@ master_doc = 'index'
|
|||
# General information about the project.
|
||||
copyright = u'2014-present, OpenStack Foundation.'
|
||||
|
||||
# done by the openstackdocstheme ext
|
||||
#project = u'Cloudkitty'
|
||||
#release = cloudkitty_version.version_string_with_vcs()
|
||||
#version = cloudkitty_version.canonical_version_string()
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#language = None
|
||||
|
@ -124,7 +119,7 @@ add_module_names = True
|
|||
show_authors = True
|
||||
|
||||
# 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 = ['cloudkitty.']
|
||||
|
@ -179,12 +174,6 @@ html_theme_options = {
|
|||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
#html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
|
|
@ -40,11 +40,11 @@ ddt==1.0.1 # MIT
|
|||
gabbi==1.26.1 # Apache-2.0
|
||||
testscenarios==0.4 # Apache-2.0/BSD
|
||||
stestr==2.0.0 # Apache-2.0
|
||||
sphinx==1.8.0 # BSD
|
||||
openstackdocstheme==1.30.0 # Apache-2.0
|
||||
sphinx==2.0.0 # BSD
|
||||
openstackdocstheme==2.2.1
|
||||
oslotest==1.10.0 # Apache-2.0
|
||||
sphinxcontrib-pecanwsme==0.8 # Apache-2.0
|
||||
reno==1.8.0 # Apache2
|
||||
reno==3.1.0
|
||||
sphinxcontrib-httpdomain==1.6.0 # Apache-2.0
|
||||
doc8==0.6.0 # Apache-2.0
|
||||
Pygments==2.2.0 # BSD
|
||||
|
|
|
@ -81,7 +81,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 = []
|
||||
|
@ -130,11 +130,6 @@ html_static_path = ['_static']
|
|||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||
# typographically correct entities.
|
||||
#html_use_smartypants = True
|
||||
|
@ -257,6 +252,6 @@ texinfo_documents = [
|
|||
#texinfo_no_detailmenu = False
|
||||
|
||||
# -- Options for openstackdocstheme -------------------------------------------
|
||||
repository_name = 'openstack/cloudkitty'
|
||||
bug_project = 'cloudkitty'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/cloudkitty'
|
||||
openstackdocs_auto_name = False
|
||||
openstackdocs_use_storyboard = True
|
||||
|
|
|
@ -11,12 +11,12 @@ ddt>=1.0.1 # MIT
|
|||
gabbi>=1.26.1 # Apache-2.0
|
||||
testscenarios>=0.4 # Apache-2.0/BSD
|
||||
stestr>=2.0.0 # Apache-2.0
|
||||
sphinx>=1.8.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=1.30.0 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
oslotest>=1.10.0 # Apache-2.0
|
||||
sphinxcontrib-httpdomain>=1.6.0 # BSD
|
||||
sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
|
||||
reno>=1.8.0 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
doc8>=0.6.0 # Apache-2.0
|
||||
Pygments>=2.2.0 # BSD license
|
||||
bandit>=1.6.0 # Apache-2.0
|
||||
|
|
Loading…
Reference in New Issue