Configure Read the Docs for automated documentation builds#21
Merged
Conversation
- Add .readthedocs.yaml (required since Sept 2023 for RTD builds) - Add docs/requirements.txt with sphinx and sphinx_rtd_theme deps - Fix sys.path in conf.py to point to project root (../../) instead of docs/ https://claude.ai/code/session_015J5urZw2vzKDQCCbXoBCKu
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
2 participants
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
This PR adds Read the Docs configuration and documentation build dependencies to enable automated documentation generation and hosting.
Key Changes
.readthedocs.yamlconfiguration file specifying:docs/source/conf.pydocs/requirements.txtdocs/requirements.txtwith Sphinx and Read the Docs theme dependenciesdocs/source/conf.pyto correctly reference the project root (changed from../to../../)Implementation Details
The path adjustment in
conf.pywas necessary because the Sphinx configuration file is located indocs/source/, so it needs to traverse up two directory levels to reach the project root, rather than just one.