Request: (linkable) API documentation #359
Description
RADICAL Pilot provides some API documentation in terms of radical.utils entities. The lack of online radical.utils API documentation causes holes in the radical.pilot documentation. In some cases, this is addressed by effectively duplicating some documentation in radical.pilot, which presents a maintainability problem.
Some common examples
- ru.Url
- ru.Config
- ru.Logger
- ru.Reporter
In general, web documentation could (or should) be derived from new or existing docstrings. It may be overly noisy to use the Sphinx auto-api-doc script to generate complete package documentation, especially since module docstrings are frequently missing and the docstrings have not been normalized to be parsed cleanly. Given that the current rtd site is nearly empty, a small hand-curated subset of API elements would seem better than nothing.
@eirrgang volunteers to do a spot check of ru references in rp docstrings for an initial "Commonly used API features" section, if there is any interest.