InnerEye-DeepLearning icon indicating copy to clipboard operation
InnerEye-DeepLearning copied to clipboard

Add `InnerEye/ML` docstrings to ReadTheDocs

Open peterhessey opened this issue 3 years ago • 1 comments

Is there an existing issue for this?

  • [X] 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 avatar Jul 26 '22 15:07 peterhessey

Look into using the sphinx autosummary tool for this.

peterhessey avatar Aug 04 '22 09:08 peterhessey