InsightSoftwareConsortium / itkwidgets

An elegant Python interface for visualization on the web platform to interactively generate insights into multidimensional images, point sets, and geometry.
https://itkwidgets.readthedocs.io/
Apache License 2.0
576 stars 83 forks source link

Generate API documentation #691

Closed tbirdso closed 9 months ago

tbirdso commented 9 months ago

The itkwidgets documentation at https://itkwidgets.readthedocs.io/en/latest/deployments.html is useful for getting started, but does not seem to provide a comprehensive overview of the itkwidgets Python API. Existing documentation provides "common flags" for CLI development, which implies that more flags are available for advanced use. Meanwhile, it's not clear what keyword inputs are available for itkwidgets.view, etc.

It would be helpful to have comprehensive API documentation available as part of that documentation. It may be reasonable to generate that API documentation if docstrings are available inline.