Properly documents methods of DataFrameClient
The uplink decorators turns the functions into objects and Sphinx isn't auto documenting them meaningfully, even though the special methods like __doc__ are preserved.
After some trial and error, I discovered that manually specifying the methods with automethod:: gets Sphinx to treat the objects like functions and generate the correct docs.
Reduces the clutter on the index page by reducing the TOC depth
What does this Pull Request accomplish?
Properly documents methods of
DataFrameClient
The uplink decorators turns the functions into objects and Sphinx isn't auto documenting them meaningfully, even though the special methods like__doc__
are preserved. After some trial and error, I discovered that manually specifying the methods withautomethod::
gets Sphinx to treat the objects like functions and generate the correct docs.Reduces the clutter on the index page by reducing the TOC depth
Why should this Pull Request be merged?
It makes the docs better!
What testing has been done?