diff options
| author | Cristián Maureira-Fredes <cristian.maureira-fredes@qt.io> | 2024-01-17 13:45:31 +0100 |
|---|---|---|
| committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2024-01-18 10:48:32 +0000 |
| commit | ae59d6e758d6be23e009fe3d7a6f744261d7c437 (patch) | |
| tree | fa3d07adede28a4b700e0f21961d02bb50f1bcca | |
| parent | 25e898fc680d0f8a44c5d645331fdfbd3d1e80eb (diff) | |
doc: use modified version of the sphinx theme
This modifies our requirements in order to use a forked
version, including the option 'collapse_navbar' for the theme
in order to avoid long build times.
Change-Id: Id0f144d19927f481f254397babb95693c131bdc3
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
(cherry picked from commit cb4d09368dd3719e3e17afa07020c4d41fb03100)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
| -rw-r--r-- | requirements-doc.txt | 6 | ||||
| -rw-r--r-- | sources/pyside6/doc/conf.py.in | 5 |
2 files changed, 10 insertions, 1 deletions
diff --git a/requirements-doc.txt b/requirements-doc.txt index 6bc00f321..70eb85bf6 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -3,5 +3,9 @@ sphinx-design==0.5.0 sphinx-copybutton==0.5.2 sphinx-tags==0.3.1 myst-parser==2.0.0 -furo==2023.9.10 +# FIXME: Using fork in order to enable the 'collapse_navbar=True' +# option for the sphinx-theme. Upstream proposal: +# https://github.com/pradyunsg/furo/pull/748#issuecomment-1895448722 +# furo==2023.9.10 +furo @ git+https://github.com/cmaureir/furo@add_collapse graphviz==0.20 diff --git a/sources/pyside6/doc/conf.py.in b/sources/pyside6/doc/conf.py.in index dd2d5ea9b..65cad73fd 100644 --- a/sources/pyside6/doc/conf.py.in +++ b/sources/pyside6/doc/conf.py.in @@ -138,6 +138,11 @@ html_theme = 'furo' # further. For a list of options available for each theme, see the # documentation. html_theme_options = { + # FIXME: This option is currently enable because on the 'requirements-doc.txt' + # We are using a fork of the theme, to include this new option. + # This needs to be removed once the functionality is either upstreamed, + # or a similar option is provided. + "collapse_navbar": True, "dark_css_variables": { "color-brand-primary": "#2cde85", "color-brand-content": "#2cde85", |