You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I just saw this problem with my own docs, and I was checking here to see if you had a solution, since I copied your docs setup. When a class has a docstring and its __init__ also has a docstring, only the class docstring goes into the docs, and the __init__ docstring gets eaten. See, e.g., FunctionalCorrector, whose __init__ docstring goes nowhere. This means the input arguments to the class constructor don't get documented.
One solution is to add autoapi_python_class_content = 'both' to docs/source/conf.py, to concatenate the __init__ docstring to the class docstring
The text was updated successfully, but these errors were encountered:
I just saw this problem with my own docs, and I was checking here to see if you had a solution, since I copied your docs setup. When a class has a docstring and its
__init__
also has a docstring, only the class docstring goes into the docs, and the__init__
docstring gets eaten. See, e.g.,FunctionalCorrector
, whose__init__
docstring goes nowhere. This means the input arguments to the class constructor don't get documented.One solution is to add
autoapi_python_class_content = 'both'
todocs/source/conf.py
, to concatenate the__init__
docstring to the class docstringThe text was updated successfully, but these errors were encountered: