Remove ReadTheDocs integration from climakitae#788
Merged
Conversation
acordonez
approved these changes
Jun 23, 2026
acordonez
left a comment
Contributor
There was a problem hiding this comment.
Test steps 1-4 all worked as expected. Can't find any readthedocs references in this branch.
Optional step 5 is throwing the same error as the last documentation PR, so I have not checked that:
Error: MkDocs encountered an error parsing the configuration file: while constructing a Python object
cannot find module 'pymdownx.superfences' (No module named 'pymdownx')
in "/Users/anaordonez/Documents/Code/climakitae/mkdocs.yml", line 88, column 19
Collaborator
Ditto, otherwise LGTM |
claalmve
approved these changes
Jun 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes and related issue
This PR removes ReadTheDocs from the climakitae repository and consolidates documentation around MkDocs/GitHub-hosted docs.
Changes included:
.readthedocs.yamlpyproject.tomlto GitHub Pagesdocs/and associated Sphinx requirements filesRelated issue: AE-1556
Link to corresponding Jira ticket(s)
https://eaglerockanalytics.atlassian.net/browse/AE-1556
Testing
How to Test
docs/remove-readthedocs.git grep -n "readthedocs"test ! -f .readthedocs.yaml && echo "removed"pyproject.tomlpointsDocumentationtohttps://cal-adapt.github.io/climakitae/dev/README.mdcontributing/docs links no longer point toclimakitae.readthedocs.iomkdocs buildDocumentation
Which of the following need updating? Check all that apply and complete them:
docs-mkdocs/climate-data-interface/) — update if you changed how a processor, validator, or data access component worksCode Quality
_Review Process
Requested review type: technical/docs + repository hygiene.
Requested review detail: medium; focus on link correctness, removal completeness, and whether deleting legacy
docs/is acceptable for current docs strategy.Administrative Reminders