Skip to content

Commit 2f60122

Browse files
committed
Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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. 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. 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. Set openstackdocs_auto_name to use 'project' as name. Depends-On: https://review.opendev.org/728938 Change-Id: Ic9b4859ad14431c2ab6cc67e053757c0e728d40e
1 parent f01c1d6 commit 2f60122

File tree

4 files changed

+10
-16
lines changed

4 files changed

+10
-16
lines changed

doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# The order of packages is significant, because pip processes them in the order
22
# of appearance. Changing the order has an impact on the overall integration
33
# process, which may cause wedges in the gate later.
4-
openstackdocstheme>=1.20.0 # Apache-2.0
5-
reno>=2.5.0 # Apache-2.0
6-
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
4+
openstackdocstheme>=2.2.0 # Apache-2.0
5+
reno>=3.1.0 # Apache-2.0
6+
sphinx>=2.0.0,!=2.1.0 # BSD
77
sphinxcontrib-apidoc>=0.2.0 # BSD

doc/source/conf.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,9 @@
1818

1919

2020
# openstackdocstheme options
21-
repository_name = 'openstack/python-ironicclient'
22-
use_storyboard = True
21+
openstackdocs_repo_name = 'openstack/python-ironicclient'
22+
openstackdocs_pdf_link = True
23+
openstackdocs_use_storyboard = True
2324

2425
# autodoc generation is a bit aggressive and a nuisance when doing heavy
2526
# text edit cycles.

lower-constraints.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ msgpack-python==0.4.0
4242
munch==2.1.0
4343
netaddr==0.7.18
4444
netifaces==0.10.4
45-
openstackdocstheme==1.20.0
4645
openstacksdk==0.18.0
4746
os-client-config==1.28.0
4847
os-service-types==1.2.0
@@ -79,16 +78,13 @@ python-openstackclient==3.12.0
7978
python-subunit==1.0.0
8079
pytz==2013.6
8180
PyYAML==3.12
82-
reno==2.5.0
8381
requests-mock==1.2.0
8482
requests==2.14.2
8583
requestsexceptions==1.2.0
8684
restructuredtext-lint==1.1.1
8785
rfc3986==0.3.1
8886
simplejson==3.5.1
8987
snowballstemmer==1.2.1
90-
Sphinx==1.6.2
91-
sphinxcontrib-websupport==1.0.1
9288
stestr==1.0.0
9389
stevedore==1.20.0
9490
tempest==17.1.0

releasenotes/source/conf.py

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,10 @@
4343
]
4444

4545
# openstackdocstheme options
46-
repository_name = 'openstack/python-ironicclient'
47-
bug_project = 'python-ironicclient'
48-
bug_tag = ''
46+
openstackdocs_repo_name = 'openstack/python-ironicclient'
47+
openstackdocs_bug_project = 'python-ironicclient'
48+
openstackdocs_bug_tag = ''
49+
openstackdocs_auto_name = False
4950

5051
# Add any paths that contain templates here, relative to this directory.
5152
templates_path = ['_templates']
@@ -148,10 +149,6 @@
148149
# directly to the root of the documentation.
149150
# html_extra_path = []
150151

151-
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
152-
# using the given strftime format.
153-
html_last_updated_fmt = '%Y-%m-%d %H:%M'
154-
155152
# If true, SmartyPants will be used to convert quotes and dashes to
156153
# typographically correct entities.
157154
# html_use_smartypants = True

0 commit comments

Comments
 (0)