Skip to content
This repository has been archived by the owner on Jun 28, 2024. It is now read-only.

Sphinx extension for automatically documenting dataclass fields

License

Notifications You must be signed in to change notification settings

illuscio-dev/sphinx_data_fields-py

Repository files navigation

Sphinx Data Fields

Sphinx Extension for Automatically Documenting Dataclass fields through sphinx-autodoc

Installation

pip install sphinx_data_fields

Getting Started

For full documentation: read the docs.

For library development guide, read the docs.

Prerequisites

Python 3.6+

Authors

  • Billy Peake - Initial work