Add documentation for the API

[jaraco]

In GitLab by @pradyunsg on Apr 16, 2020, 16:17

It'd be great to have API reference documentation, like https://packaging.pypa.io/en/latest/version/#reference for importlib.metadata. It'd be nice to know exactly what functions, classes, attributes, and methods are publicly available for various bits of functionality provided by this project.

[jaraco]

In GitLab by @jaraco on Jun 5, 2020, 15:46

Yes, I agree. The existing docs do enumerate most of the supported functions and classes, but it reads more like a manual than a reference. I'd be open to adding a reference to the source to document the supported API. Would you be willing to draft a MR?

[jaraco]

In my other projects, I rely heavily on autodoc. I'd be more than happy to include that in reference documentation, but I'm not sure how well that's supported in CPython (with which this project attempts to stay in sync). In the bpo-37741, this issue was addressed for CPython by simply linking to the source. Perhaps this project could do the same.