openstack/openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
573 Commits 1 Branch 88 Tags 9 MiB
HTML 32.1%
Python 31.6%
CSS 16.4%
Shell 7.1%
Makefile 5.3%
Other 7.5%
08461c5311
Go to file
Stephen Finucane 08461c5311 Inherit from base "basic" template 
Sphinx 4.x changed how it includes some JavaScript files. Instead of
including them via the template, they are now injected using the
'add_js_file' function [1]. This relies on a custom Jinja2 function,
'js_tag' to generate the correct element with necessary attributes set.
Failure to use this results in missing attributes for some tags.

Rather than simply reworking our template to use this new function,
change how we use our 'layout.html' to instead override the 'basic'
template that Sphinx provides. This means we should get these kinds of
changes "for free" in the future, rather than having to worry about
them.

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

Change-Id: Idc0e6c1d38407fdadc29ea710069e74243c5c89a
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-05-31 16:45:40 +01:00
api-ref/source Adding pre-commit 2020-09-15 14:46:10 +02:00
bin Update hacking for Python3 2020-03-30 12:01:30 +00:00
doc Change name of OpenStack Foundation 2020-10-22 09:51:36 +02:00
openstackdocstheme Inherit from base "basic" template 2021-05-31 16:45:40 +01:00
releasenotes Adding pre-commit 2020-09-15 14:46:10 +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
.pre-commit-config.yaml Move flake8 as a pre-commit local target. 2021-03-23 13:14:42 +01:00
.zuul.yaml Add octaviaclient cross job 2020-05-19 11:53:00 +02:00
bindep.txt Merge "Add cross-tests for nova" 2020-05-19 21:19:31 +00: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
index.rst Update Launchpad info 2017-02-17 10:26:28 +10: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 Change name of OpenStack Foundation 2020-10-22 09:51:36 +02:00
requirements.txt Updated from global requirements 2017-08-03 00:38:12 +00:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-05-05 10:07:56 +08:00
setup.py [ussuri][goal] Drop python 2.7 support and testing 2020-02-05 19:42:12 +01:00
test-requirements.txt Adding pre-commit 2020-09-15 14:46:10 +02:00
tox.ini tox: Toggle 'usedevelop' 2021-05-31 16:45:40 +01:00

README.rst

Team and repository tags

image

Open Infrastructure Projects Sphinx Themes

Theme and extension support for Sphinx documentation that is published by Open Infrastructure 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