Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use up-to-date sphinx_rtd_theme extension #6226

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

tenzap
Copy link
Contributor

@tenzap tenzap commented Jun 27, 2023

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

You may want to tweak some options & update the configuration of the theme if you want it to look exactly like before.

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
@tenzap
Copy link
Contributor Author

tenzap commented Feb 10, 2024

IIRC I recently saw a similar change in CI4

@kenjis
Copy link
Contributor

kenjis commented Feb 10, 2024

CI4 are using Sphinx 5.3.
codeigniter4/CodeIgniter4#8428

@tenzap
Copy link
Contributor Author

tenzap commented Feb 10, 2024

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.
Btw I was able to make cilexer work even with python 3.12, so I'm not sure it was actually required to remove it in ci4.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants