diff options
| author | Andreas Jaeger <aj@suse.com> | 2020-06-02 18:53:59 +0200 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2020-06-03 08:31:04 +0200 |
| commit | 3d105b623d13d8fe6bb4db676196a44ac3db464f (patch) | |
| tree | aaded49f26c46d0e7c7d85e5e9338beafc667916 /releasenotes | |
| parent | 019bade19cd20aaebb6dd1f423ab2dbb15cd12a1 (diff) | |
| download | swift-3d105b623d13d8fe6bb4db676196a44ac3db464f.tar.gz | |
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.
Disable openstackdocs_auto_name to use 'project' variable as name.
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: I131850d2a5c6164dfd48c9c95885d4754b5236c6
Diffstat (limited to 'releasenotes')
| -rw-r--r-- | releasenotes/source/conf.py | 14 |
1 files changed, 5 insertions, 9 deletions
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 1dea1af1d..932a4cbbd 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -116,7 +116,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # 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 = [] @@ -174,11 +174,6 @@ html_theme = 'openstackdocs' # # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # @@ -352,6 +347,7 @@ htmlhelp_basename = 'SwiftReleaseNotesdoc' locale_dirs = ['locale/'] # -- Options for openstackdocstheme ------------------------------------------- -repository_name = 'openstack/swift' -bug_project = 'swift' -bug_tag = '' +openstackdocs_repo_name = 'openstack/swift' +openstackdocs_auto_name = False +openstackdocs_bug_project = 'swift' +openstackdocs_bug_tag = '' |