openstack
/
openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
552 Commits 1 Branch 86 Tags 8.4 MiB
HTML 32.3%
Python 31.2%
CSS 16.5%
Shell 7.1%
Makefile 5.3%
Other 7.6%
Go to file
Stephen Finucane 9efc192021 js: Set 'LINK_SUFFIX' 
Sphinx 3.0.0 changed the behavior of JavaScript-based search utility,
changing the configuration option used to determine the suffix for
search results from 'html_file_suffix' to 'html_link_suffix' [1]. We
were manually overriding 'DOCUMENTATION_OPTIONS' and were not setting
the 'LINK_SUFFIX' attribute, which maps to this config option, meaning
our resulting URLs looked like 'fooundefined', where 'foo' is the name
of the file.

Add 'LINK_SUFFIX', resolving this issue.

[1] https://github.com/sphinx-doc/sphinx/commit/a717ffec78

Change-Id: I06488225cf0431e601f16e0f1047a6088a11d5bd
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
Closes-bug: #1880331
 		2020-09-22 12:02:53 +01:00
api-ref/source Update docstheme 2020-05-15 08:50:51 +02:00
bin Update hacking for Python3 2020-03-30 12:01:30 +00:00
doc Add link to PDF file 2020-05-18 14:58:31 +02:00
openstackdocstheme js: Set 'LINK_SUFFIX' 2020-09-22 12:02:53 +01:00
releasenotes Show version in PDFs 2020-05-20 14:03:08 +02:00
.gitignore ignore files created during packaging 2018-07-26 03:59:59 -04:00
.gitreview OpenDev Migration Patch 2019-04-19 19:32:44 +00:00
.zuul.yaml Add octaviaclient cross job 2020-05-19 11:53:00 +02:00
CONTRIBUTING.rst Update several links 2020-03-21 09:14:00 +01:00
HACKING.rst Update 2 documentation URLs according to doc migration 2017-07-24 17:13:26 +08:00
LICENSE Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
Makefile Starting point for Sphinx theme for docs.openstack.org content 2015-01-20 10:49:21 -06:00
README.rst Update for OpenDev change 2019-04-21 14:27:39 +00:00
bindep.txt Merge "Add cross-tests for nova" 2020-05-19 21:19:31 +00:00
index.rst Update Launchpad info 2017-02-17 10:26:28 +10:00
requirements.txt Updated from global requirements 2017-08-03 00:38:12 +00:00
setup.cfg Add py38 package metadata 2020-06-01 16:06:38 +08:00
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:42:12 +01:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-05-22 11:19:54 +08:00
tox.ini Enable parallel building 2020-05-16 12:26:53 +02:00

README.rst

Team and repository tags

image

OpenStack Foundation Sphinx Themes

Theme and extension support for Sphinx documentation that is published by OpenStack Foundation projects.

OpenStack docs.openstack.org Sphinx Theme

Theme support for Sphinx documentation that is published to docs.openstack.org and developer.openstack.org.

Intended for use by OpenStack projects governed by the Technical Committee.

StarlingX docs.starlingx.io Sphinx Theme

Theme support for Sphinx documentation that is published to docs.starlingx.io.

Intended for use by StarlingX projects governed by the Technical Steering Committee.

References