use up-to-date sphinx_rtd_theme extension #6226
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently sphinx_rtd_theme is a fixed asset in the repository. This can lead to various problems: - search doesn't work anymore when building the doc with recent sphinx - generated html & js code not in line with current standard - no fixes from upstream are integrated BTW, as per the doc at: https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html#via-git-or-download Installing directly from the repository source is deprecated and is not recommended. Static assets won’t be included in the repository starting in release 3.0.0. This removes the theme, and updates conf.py to use the now prefered method to get it as per: https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html#how-to-install-and-use-the-theme
|
IIRC I recently saw a similar change in CI4 |
|
CI4 are using Sphinx 5.3. |
|
That's not the one I was thinking of. There was one which removed the sphinx theme. The change of this pr is already applied in the Debian package, but yes Debian runs a recent version of sphinx I guess. I think it was commit codeigniter4/CodeIgniter4@806bb40 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently sphinx_rtd_theme is a fixed asset in the repository.
This can lead to various problems:
BTW, as per the doc at:
https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html#via-git-or-download
Installing directly from the repository source is deprecated and is not recommended. Static assets won’t be included in the repository starting in release 3.0.0.
This removes the theme, and updates conf.py to use the now prefered method to get it as per:
https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html#how-to-install-and-use-the-theme
You may want to tweak some options & update the configuration of the theme if you want it to look exactly like before.