openstack/openstackdocstheme
Code Issues Proposed changes
Sphinx theme for RST-sourced documentation published to docs.openstack.org
582 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%
20bf587d68
Go to file
Stephen Finucane 20bf587d68 Only hide top-level duplicated title 
In change I48b923a67010c92945c46ab00de0b090ba7cd465, way back in 2016,
we started hiding duplicate titles caused by us including the first h1
title we found at the top of the page. Unfortunately, the fix for this
was to hide *all* h1 titles found in the main docs body. Sphinx doesn't
insist on only a single h1 title (in fact, the sphinx-quickstart tool
produces an index.rst with two h1 titles) which means we were hiding a
lot of information unwittingly. Fix this by only hiding the first title,
as originally intended.

Also replace deprecated whitelist_externals by allowlist_externals
in tox.ini.

Change-Id: Ic8fc5e1256b4ab8925401fe6781210729a68d2aa
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2023-02-23 21:29:53 +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 Only hide top-level duplicated title 2023-02-23 21:29:53 +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 Drop python3.6/3.7 support in testing runtime 2022-05-05 16:19:19 +02: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 Only hide top-level duplicated title 2023-02-23 21:29:53 +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