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
Describe the bug
Handmaded docstrings for attributes are ignored by sphinx autodoc and replaced by alias of.
To Reproduce
Create default sphinx project with autodoc extension.
Create example_code.py with content:
fromtypingimportUnion, TypeclassMyClass:
"""Class ``MyClass`` docstring."""#: This comment is not displayed.int_attr=int#: This comment is not displayed.typed_attr: Union[Type[int], Type[str]] =int
Build html documenation for example_code.py.
Expected behavior
I expect to see This comment is not displayed. docstring for int_attr and typed_attr attributes,
but I see alias of int docstring.
Describe the bug
Handmaded docstrings for attributes are ignored by sphinx autodoc and replaced by
alias of
.To Reproduce
example_code.py
with content:html
documenation forexample_code.py
.Expected behavior
I expect to see
This comment is not displayed.
docstring forint_attr
andtyped_attr
attributes,but I see
alias of int
docstring.Environment info
Additional context
Possibly related:
The text was updated successfully, but these errors were encountered: