Currently, we use all three of sphinx-apidoc command, sphinx.ext.autodoc extension, and .. automodule:: directive to automatically generate api documentation.
There are several weaknesses to the current structure
no control over the organization of api reference rst files and toctrees
duplicated items (e.g, btb.HyperParameter vs btb.hyper_parameter.HyperParameter)
We should clean this up a little bit so that a brand new package has a reasonable API reference, but not try to do too much, and instead defer to package authors for customization
Currently, we use all three of
sphinx-apidoccommand,sphinx.ext.autodocextension, and.. automodule::directive to automatically generate api documentation.There are several weaknesses to the current structure
We should clean this up a little bit so that a brand new package has a reasonable API reference, but not try to do too much, and instead defer to package authors for customization