-
Notifications
You must be signed in to change notification settings - Fork 4
feat: adding read the docs config file #97
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
Conversation
|
Thanks for the pull request, @felipemontoya! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #97 +/- ##
=======================================
Coverage 90.58% 90.58%
=======================================
Files 47 47
Lines 4310 4310
Branches 271 271
=======================================
Hits 3904 3904
Misses 317 317
Partials 89 89
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds a root-level Read the Docs configuration file to enable documentation building for the repository. The configuration points to the existing Sphinx documentation in the docs/ directory and specifies Python 3.12 as the build environment.
Key changes:
- Adds
.readthedocs.yamlconfiguration file with Sphinx build settings - Configures documentation build to use
backend/requirements/doc.txtand install the backend package - Sets fail_on_warning to enforce documentation quality
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
13ba716 to
2b74991
Compare
34aeb28 to
a5764f0
Compare
|
Tested this using a build from my own account of read the docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR adds the necessary config file for read the docs.
See: openedx/axim-engineering#1632