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: I49a5a5876b0b995df0c3ce55fd517fa81bd79fd2
This commit is contained in:
parent
4561a16294
commit
eef6ddd62d
@ -42,12 +42,12 @@ master_doc = 'index'
|
|||||||
copyright = u'2016-present, OpenStack Foundation'
|
copyright = u'2016-present, OpenStack Foundation'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/cyborg'
|
openstackdocs_repo_name = 'openstack/cyborg'
|
||||||
bug_project = 'cyborg'
|
openstackdocs_bug_project = 'cyborg'
|
||||||
bug_tag = 'api-ref'
|
openstackdocs_bug_tag = 'api-ref'
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
@ -7,6 +7,6 @@ sphinxcontrib-httpdomain>=1.3.0 # BSD
|
|||||||
sphinxcontrib-pecanwsme>=0.2 # Apache-2.0
|
sphinxcontrib-pecanwsme>=0.2 # Apache-2.0
|
||||||
sphinxcontrib-seqdiag>=0.8.4 # BSD
|
sphinxcontrib-seqdiag>=0.8.4 # BSD
|
||||||
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
|
||||||
reno>=2.5.0 # Apache-2.0
|
reno>=3.1.0 # Apache-2.0
|
||||||
os-api-ref>=1.4.0 # Apache-2.0
|
os-api-ref>=1.4.0 # Apache-2.0
|
||||||
openstackdocstheme>=2.0.0 # Apache-2.0
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
|
@ -44,9 +44,10 @@ master_doc = 'index'
|
|||||||
copyright = u'2013, OpenStack Foundation'
|
copyright = u'2013, OpenStack Foundation'
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/cyborg'
|
openstackdocs_repo_name = 'openstack/cyborg'
|
||||||
bug_project = 'cyborg'
|
openstackdocs_pdf_link = True
|
||||||
bug_tag = ''
|
openstackdocs_bug_project = 'cyborg'
|
||||||
|
openstackdocs_bug_tag = ''
|
||||||
|
|
||||||
config_generator_config_file = '../../tools/config/cyborg-config-generator.conf'
|
config_generator_config_file = '../../tools/config/cyborg-config-generator.conf'
|
||||||
sample_config_basename = '_static/cyborg'
|
sample_config_basename = '_static/cyborg'
|
||||||
@ -64,7 +65,7 @@ add_function_parentheses = True
|
|||||||
add_module_names = True
|
add_module_names = True
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
|
@ -15,9 +15,9 @@ extensions = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/cyborg'
|
openstackdocs_repo_name = 'openstack/cyborg'
|
||||||
bug_project = 'openstack-cyborg'
|
openstackdocs_bug_project = 'openstack-cyborg'
|
||||||
bug_tag = ''
|
openstackdocs_bug_tag = ''
|
||||||
|
|
||||||
# The suffix(es) of source filenames.
|
# The suffix(es) of source filenames.
|
||||||
# You can specify multiple suffix as a list of string:
|
# You can specify multiple suffix as a list of string:
|
||||||
@ -54,7 +54,7 @@ language = None
|
|||||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||||
|
|
||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'native'
|
||||||
|
|
||||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
todo_include_todos = False
|
todo_include_todos = False
|
||||||
|
Loading…
Reference in New Issue
Block a user