hghcomphys / pantea

A Python library for developing machine learning interatomic potentials, based on Google JAX.

Home Page:https://pantea.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Adding sphinx autodoc for dataclasses, namedtuples, typeddicts, etc.

hghcomphys opened this issue · comments

It seems that sphinx autodoc cannot generate an informative docs for dataclasses, namedtuples, and typeddicts.
This issue was already solved for pydantic classes by using an autodoc_pydantic extension but problem still exists for those classes.

For dataclasses, namedtuples, and typeddicts a simple docstring after each attribute can be used.