This repository was archived by the owner on Mar 21, 2024. It is now read-only.
DOC: Add all InnerEye/ML docstrings to ReadTheDocs#783
Merged
peterhessey merged 23 commits intomainfrom Aug 16, 2022
Merged
Conversation
peterhessey
changed the title
peterhessey
force-pushed
the
phessey/update-API-docs
branch
from
ef3a838 to
416e907
Compare
peterhessey
changed the title
InnerEye/ML docstrings to ReadTheDocs
Contributor
Author
|
The sphinx-build process is still dumping a million warnings currently. This will be fixed in a separate PR - I think that a lot of these will disappear when we switch to a new reStructuredText parser. |
fepegar
approved these changes
Aug 9, 2022
Contributor
fepegar
left a comment
fepegar
left a comment
There was a problem hiding this comment.
Approved with some comments. Looks great!!
ant0nsc
approved these changes
Aug 15, 2022
1 task
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
Closes #774
Adds all the docstrings in
InnerEye/MLto the ReadTheDocs site.Includes many corrections to docstrings formatting to ensure that they render correctly.
Apologies for the size of PR, but the majority of the line changes are whitespace erro and reStructuredText formatting corrections that I automated to save time. The critical changes for review are all found in the
docs/directory. i.e. the.rstfiles.