Details
-
Type:
Bug
-
Status: To Do
-
Resolution: Unresolved
-
Fix Version/s: None
-
Component/s: afw
-
Labels:None
-
Story Points:0.4
-
Epic Link:
-
Team:SQuaRE
Description
As part of DM-16858, I tried to link to `lsst.afw.display.BLACK` but the link would not resolve. BLACK and its related constants also do not appear in the package documentation, despite being provided by __all__. Behavior does not change under the following changes:
- Adding a one-line docstring to BLACK
- Changing __all__ from a tuple to a list
Krzysztof Findeisen: short answer is that we need the include-all-objects flag to make this happen, as in:
.. automodapi:: lsst.afw.display
:no-main-docstr:
:no-inheritance-diagram:
:include-all-objects:
automodapi doensn't have a way of making this a default, so I'll have to either upstream a change to automodapi, or update the templates to include this.
I also can't get my own docstrigs to be used — I'm always getting an autogenerated Pybind11 docstring for these constants.