openstack/openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
572 Commits 1 Branch 89 Tags 9 MiB
HTML 32.1%
Python 31.6%
CSS 16.4%
Shell 7.1%
Makefile 5.3%
Other 7.5%
9602f39783
Go to file
Stephen Finucane 9602f39783 sphinx 4.0: Handle HTML 5 changes 
Sphinx 4.0 includes a newer version of docutils, which makes some
changes to the HTML 5 writer. Among these is the change in HTML
generated for the 'ObjectDescription' directive, which is used to
generate definition-list style output for things like oslo.config.
Previously, the title of each entry would be styled like so:

  <dt id="DEFAULT.internal_service_availability_zone">
    <code class="sig-name descname">
      <span class="pre">internal_service_availability_zone</span>
    </code>
  </dt>

Now the improper use of the 'code' element is dropped, in favour of a
'span', like so:

  <dt class="sig sig-object oslo.config" id="DEFAULT.internal_service_availability_zone">
    <span class="sig-name descname">
      <span class="pre">internal_service_availability_zone</span>
    </span>
    ...
  </dt>

Change-Id: I9fb9fbce6299600c3085bea1b8f17ad796bec4f8
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 sphinx 4.0: Handle HTML 5 changes 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