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

Reset doc theme to ReadTheDocs' default theme #457

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

ewjoachim
Copy link
Contributor

On 2023, RTD made changes to the tools that are automatically installed. I'm pretty sure (though that might a false memory) that the Asgi doc used to use the rtd theme. Fact is that it now uses the default theme which looks so retro it belongs in a museum.

This PR resets the theme to RTD.
What this PR exactly does:

  • Add a docs/requirements.txt file with docs dependencies
  • Change the value for the theme

What this PR doesn't do but could (you tell me):

  • Pin dependencies in docs/requirements.txt (I don't see dependabot or renovate being used in the repo so I'm wary of adding pinned deps, as they'll likely get old quick)
  • Use a more modern theme such as Pradyun's excellent furo

I haven't changed the RTD build, and I see that this repo isn't configured to build docs in PRs. It should be as simple as checking this checkbox in the RTD admin, as long as github permissions are set correctly:
image

image

before

Screenshot from 2024-03-22 19-46-13

after

@ewjoachim ewjoachim changed the title Reset theme to ReadTheDocs' default theme Reset doc theme to ReadTheDocs' default theme Mar 22, 2024
@carltongibson carltongibson merged commit db3ff43 into django:main Mar 22, 2024
6 checks passed
@ewjoachim ewjoachim deleted the rtd-theme branch March 22, 2024 22:02
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.

3 participants