The value replicates what is currently documented by Sphinx, which turns out to be everything. It's not clear though if that's all really meant to be consumed publicly.
In particular, there are things in xmlconfig that are marked as deprecated that are documented, and lots of things in config that are documented but look like internal details, and things that are "documented" but have no docstrings or sphinx docs. I would love to pare down the surface of the API documentation if anyone can help confirm/deny what's really meant to be public.
jamadden
commented
5 years ago
The value replicates what is currently documented by Sphinx, which turns out to be everything. It's not clear though if that's all really meant to be consumed publicly.
In particular, there are things in
xmlconfigthat are marked as deprecated that are documented, and lots of things inconfigthat are documented but look like internal details, and things that are "documented" but have no docstrings or sphinx docs. I would love to pare down the surface of the API documentation if anyone can help confirm/deny what's really meant to be public.Fixes #38