Skip to content
This repository has been archived by the owner on Mar 21, 2024. It is now read-only.

Add InnerEye/ML docstrings to ReadTheDocs #774

Closed
1 task done
peterhessey opened this issue Jul 26, 2022 · 1 comment · Fixed by #783
Closed
1 task done

Add InnerEye/ML docstrings to ReadTheDocs #774

peterhessey opened this issue Jul 26, 2022 · 1 comment · Fixed by #783
Assignees
@peterhessey
Labels
documentation Improvements or additions to documentation

Comments

@peterhessey
Copy link
Contributor

peterhessey commented Jul 26, 2022 •
edited
Loading

Is there an existing issue for this?

  • I have searched the existing issues

Issue summary

The IE-DL API for Read the Docs needs to be completed. Currently only a small subset of the code is included, and the stuff that is included produces many warnings during the build process that we should ideally be avoiding.

What documentation should be provided?

All Docstrings in InnerEye/ML should be added to the ReadTheDocs site.

AB#6801
@peterhessey peterhessey added the documentation Improvements or additions to documentation label Jul 26, 2022
@peterhessey peterhessey self-assigned this Jul 26, 2022
@peterhessey
Copy link
Contributor Author

Look into using the sphinx autosummary tool for this.

@peterhessey peterhessey mentioned this issue Aug 8, 2022
Merged
@peterhessey peterhessey changed the title Update Read the Docs API information Add InnerEye/ML docstrings to ReadTheDocs Aug 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@peterhessey peterhessey

Labels
documentation Improvements or additions to documentation
Projects
InnerEye-OSS
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOC: Add all InnerEye/ML docstrings to ReadTheDocs microsoft/InnerEye-DeepLearning
1 participant
@peterhessey