08461c5311
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>
Team and repository tags
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
- Free software: Apache License, Version 2.0
- Documentation: https://docs.openstack.org/openstackdocstheme/latest/
- Release notes: https://docs.openstack.org/releasenotes/openstackdocstheme/
- Source: https://opendev.org/openstack/openstackdocstheme
- Bugs: https://launchpad.net/openstack-doc-tools