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. 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: I481525b51df5937a9fec6c0a7528dd6ea5b6c31b
This commit is contained in:
parent
63827bf737
commit
3698744ba0
|
@ -39,9 +39,9 @@ html_theme_options = {
|
|||
}
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/murano'
|
||||
bug_project = 'murano'
|
||||
bug_tag = 'api-ref'
|
||||
openstackdocs_repo_name = 'openstack/murano'
|
||||
openstackdocs_bug_project = 'murano'
|
||||
openstackdocs_bug_tag = 'api-ref'
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
|
@ -95,7 +95,7 @@ add_module_names = False
|
|||
show_authors = False
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = 'sphinx'
|
||||
pygments_style = 'native'
|
||||
|
||||
# -- Options for man page output ----------------------------------------------
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# doc build requirements
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
sphinxcontrib-httpdomain>=1.3.0 # BSD
|
||||
reno>=2.5.0 # Apache-2.0
|
||||
openstackdocstheme>=2.0.0 # Apache-2.0
|
||||
reno>=3.1.0 # Apache-2.0
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
os-api-ref>=1.4.0 # Apache-2.0
|
||||
|
|
|
@ -55,9 +55,10 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/murano'
|
||||
bug_project = 'murano'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/murano'
|
||||
openstackdocs_pdf_link = True
|
||||
openstackdocs_bug_project = 'murano'
|
||||
openstackdocs_bug_tag = ''
|
||||
|
||||
config_generator_config_file = '../../etc/oslo-config-generator/murano.conf'
|
||||
sample_config_basename = '_static/murano'
|
||||
|
|
|
@ -59,7 +59,6 @@ murano-pkg-check==0.3.0
|
|||
netaddr==0.7.18
|
||||
netifaces==0.10.6
|
||||
nose==1.3.7
|
||||
openstackdocstheme==2.0.0
|
||||
openstacksdk==0.12.0
|
||||
os-api-ref==1.4.0
|
||||
os-client-config==1.29.0
|
||||
|
@ -117,7 +116,6 @@ python-subunit==1.2.0
|
|||
python-swiftclient==3.5.0
|
||||
pytz==2018.3
|
||||
PyYAML==3.12
|
||||
reno==2.5.0
|
||||
repoze.lru==0.7
|
||||
requests==2.14.2
|
||||
requestsexceptions==1.4.0
|
||||
|
@ -127,9 +125,6 @@ semantic-version==2.8.2
|
|||
simplejson==3.13.2
|
||||
smmap2==2.0.3
|
||||
snowballstemmer==1.2.1
|
||||
Sphinx==2.0.0
|
||||
sphinxcontrib-httpdomain==1.3.0
|
||||
sphinxcontrib-websupport==1.0.1
|
||||
sqlalchemy-migrate==0.11.0
|
||||
SQLAlchemy==1.0.10
|
||||
sqlparse==0.2.4
|
||||
|
|
|
@ -58,9 +58,9 @@ master_doc = 'index'
|
|||
copyright = u'2015, Murano Developers'
|
||||
|
||||
# openstackdocstheme options
|
||||
repository_name = 'openstack/murano'
|
||||
bug_project = 'murano'
|
||||
bug_tag = ''
|
||||
openstackdocs_repo_name = 'openstack/murano'
|
||||
openstackdocs_bug_project = 'murano'
|
||||
openstackdocs_bug_tag = ''
|
||||
|
||||
# Release notes are version independent.
|
||||
# The short X.Y version.
|
||||
|
@ -95,7 +95,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 = []
|
||||
|
|
Loading…
Reference in New Issue