Skip to content

Use Read the Docs theme in local builds#602

Merged
cjolowicz merged 5 commits intomasterfrom
retrocookie-pr/sphinx-rtd-theme
Oct 9, 2020
Merged

Use Read the Docs theme in local builds#602
cjolowicz merged 5 commits intomasterfrom
retrocookie-pr/sphinx-rtd-theme

Conversation

@cjolowicz
Copy link
Owner

@cjolowicz cjolowicz commented Oct 9, 2020

Configure Sphinx to use the Read the Docs theme.

This fixes a discrepancy between documentation builds on Read the Docs on one side (which use sphinx-rtd-theme by default), and builds on GitHub Actions and local builds on the other side (which default to Alabaster). As the documentation is hosted with Read the Docs, the discrepancy is resolved in favor of sphinx-rtd-theme, avoiding a breaking change.

Closes #564

@cjolowicz cjolowicz added the bug Something isn't working label Oct 9, 2020
@cjolowicz cjolowicz added this to the 2020.10.15 milestone Oct 9, 2020
@cjolowicz cjolowicz merged commit 2ab4056 into master Oct 9, 2020
@cjolowicz cjolowicz deleted the retrocookie-pr/sphinx-rtd-theme branch October 9, 2020 17:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The docs session and RTD use different themes

1 participant