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

docs: Update theme to ReadTheDocs always (fixes regression) #643

Merged
merged 5 commits into from
Sep 15, 2023

Conversation

JST5000
Copy link
Collaborator

@JST5000 JST5000 commented Sep 11, 2023

High Level Overview of Change

Since 2.2.0, the xrpl-py docs have been loading with a new theme. This brings it back to the previous ReadTheDocs theme.

Context of Change

It seems that the default theme changed without warning (as far as we saw):

Autogenerated theme code from before 2.2.0:
https://readthedocs.org/projects/xrpl-py/builds/21212455/
image

Autogenerated theme code from versions after/including 2.2.0:
https://readthedocs.org/projects/xrpl-py/builds/21889906/
image

In general you can check builds and autogenerated theming by going to this build page: https://readthedocs.org/projects/xrpl-py/builds/

  1. Click an individual build
  2. Click the "cat docs/conf.py"
  3. Scroll down past the "auto-generated below here" comment
  4. Look for where the theme is defined

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Documentation Updates

Did you update CHANGELOG.md?

  • No, this change does not impact library users

Test Plan

Inspection and the docs build locally with the RTD theme ✅

The true efficacy will have to be determined after merging since this is a bug that only shows up in the production docs page, not in the local builds.

How it looks after the changes on ReadTheDocs:
image

@JST5000
Copy link
Collaborator Author

JST5000 commented Sep 12, 2023

Thanks @mvadari for showing me how to activate a branch on ReadTheDocs :)

Added a screenshot for how it looks there, and updated the CONTRIBUTING.md with steps so other people can do that when modifying that config in the future.

@JST5000 JST5000 merged commit 4f44143 into master Sep 15, 2023
17 checks passed
@JST5000 JST5000 deleted the update-theme branch September 15, 2023 20:19
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.

None yet

4 participants