openstack/freezer
Code Issues Proposed changes

Switch to newer openstackdocstheme and reno versions

Browse Source 
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.

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: I502e67164a3639e2df51edbd239f2b2bab474924
This commit is contained in:
Andreas Jaeger 2020-05-30 16:46:36 +02:00
parent eaab8694d0
commit f7cd7dbe35
4 changed files with 10 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/requirements.txt
View File

@ -2,11 +2,10 @@
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD
sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD
sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
openstackdocstheme>=1.20.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
mock>=2.0.0 # BSD
ddt>=1.0.1 # MIT
testtools>=2.2.0 # MIT

6
doc/source/conf.py
View File

@ -77,9 +77,9 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
repository_name = 'openstack/freezer'
bug_project = 'freezer'
bug_tag = 'doc'
openstackdocs_repo_name = 'openstack/freezer'
openstackdocs_bug_project = 'freezer'
openstackdocs_bug_tag = 'doc'
# project = u'Freezer'
# copyright = u'2010-present, OpenStack Foundation'

4
lower-constraints.txt
View File

@ -45,7 +45,6 @@ msgpack==0.5.6
munch==2.2.0
netaddr==0.7.19
netifaces==0.10.6
openstackdocstheme==1.20.0
openstacksdk==0.12.0
os-brick==2.2.0
os-client-config==1.29.0
@ -92,7 +91,6 @@ python-subunit==1.2.0
python-swiftclient==3.2.0
pytz==2018.3
PyYAML==3.12
reno==2.5.0
repoze.lru==0.7
requests==2.18.4
requestsexceptions==1.4.0
@ -102,8 +100,6 @@ Routes==2.4.1
setuptools==21.0.0
simplejson==3.13.2
snowballstemmer==1.2.1
Sphinx==1.8.0
sphinxcontrib-websupport==1.0.1
stestr==2.0.0
stevedore==1.28.0
tempest==17.1.0

8
releasenotes/source/conf.py
View File

@ -41,9 +41,9 @@ extensions = [
]
# openstackdocstheme options
repository_name = 'openstack/freezer'
bug_project = 'freezer'
bug_tag = ''
openstackdocs_repo_name = 'openstack/freezer'
openstackdocs_bug_project = 'freezer'
openstackdocs_bug_tag = ''
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -96,7 +96,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 = []