XRPLF / xrpl-py

A Python library to interact with the XRP Ledger (XRPL) blockchain
ISC License
150 stars 84 forks source link

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

Closed JST5000 closed 1 year ago

JST5000 commented 1 year ago

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

Did you update CHANGELOG.md?

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 commented 1 year ago

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.