Skip to content

Docstring of the __init__ method missing in html docs #122

Open
@ddundo

Description

@ddundo

For example, see https://mesh-adaptation.github.io/docs/goalie.html#goalie.mesh_seq.MeshSeq . The class docstring is present, but not the __init__ docstring. In conf.py we have "class-doc-from": "both" which should include both (see https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-autoclass-class-doc-from).

I tried changing to "class-doc-from": "init" but that again did not render the __init__ docstring.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    Projects

    Status

    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions