Open
Conversation
Contributor
Author
|
@ormsbee the docs are absolutely now BUILDING on PRs: https://app.readthedocs.org/projects/openedx-core/builds/ but they are not reporting on them. I'll check with Feanil, I'm not sure what steps I may have missed. I also dug in a bit to your question about headers. With napoleon - already installed on this repo - we could convert docstrings to Google Python or NumPy-style docstrings, with sections instead of |
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
1 participant
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.
See https://daniel.feldroy.com/posts/2023-01-configuring-sphinx-auto-doc-with-django for two issues - path needed to be specified, and DJANGO_SETTINGS_MODULE needs to be set after the path is fixed.
THE DOC BUILD... IT LIVES