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: Ia65588ae734c6995c060332e5198afb95b105084
This commit is contained in:
Andreas Jaeger 2020-05-21 16:16:48 +02:00
parent 894f98c7a5
commit 7abc95f1e3
5 changed files with 16 additions and 18 deletions

View File

@ -42,9 +42,8 @@ source_encoding = 'utf-8'
master_doc = 'index'
# General details about project
repository_name = u'openstack/monasca-api'
bug_project = u'863'
bug_tag = u''
openstackdocs_repo_name = u'openstack/monasca-api'
openstackdocs_use_storyboard = True
copyright = u'2014-present, OpenStack Foundation'
author = u'OpenStack Foundation'
@ -78,7 +77,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 = []

View File

@ -40,9 +40,9 @@ extensions = [
]
# geeneral information about project
repository_name = u'openstack/monasca-api'
bug_project = u'863'
bug_tag = u''
openstackdocs_repo_name = u'openstack/monasca-api'
openstackdocs_pdf_link = True
openstackdocs_use_storyboard = True
copyright = u'2014-present, OpenStack Foundation'
author = u'OpenStack Foundation'
@ -85,7 +85,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 = ['monasca_api.', 'monasca']

View File

@ -50,7 +50,7 @@ mox3==0.20.0
msgpack-python==0.4.0
netaddr==0.7.18
netifaces==0.10.4
openstackdocstheme==1.20.0
openstackdocstheme==2.2.1
os-api-ref==1.4.0
os-client-config==1.28.0
os-testr==1.0.0
@ -87,7 +87,7 @@ python-mimeparse==1.6.0
python-subunit==1.0.0
pytz==2013.6
PyYAML==3.12
reno==2.5.0
reno==3.1.0
requests==2.14.2
requestsexceptions==1.2.0
requests-mock==1.2.0
@ -97,7 +97,7 @@ simplejson==3.8.1
six==1.10.0
smmap==0.9.0
snowballstemmer==1.2.1
sphinx==1.6.2
Sphinx==2.0.0
sphinxcontrib-websupport==1.0.1
SQLAlchemy==1.0.10
sqlalchemy-migrate==0.11.0

View File

@ -37,14 +37,13 @@ source_encoding = 'utf-8'
master_doc = 'index'
# General information about the project.
repository_name = u'openstack/monasca-api'
openstackdocs_repo_name = u'openstack/monasca-api'
openstackdocs_use_storyboard = True
# Release notes do not need a version number in the title, they
# cover multiple releases.
version = ''
release = ''
bug_project = u'863'
bug_tag = u''
copyright = u'2014-present, OpenStack Foundation'
author = u'OpenStack Foundation'
@ -78,7 +77,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 = []

View File

@ -24,7 +24,7 @@ tempest>=17.1.0 # Apache-2.0
# documentation
doc8>=0.6.0 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
os-api-ref>=1.4.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=3.1.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0