Skip to content

Documentation #2

@zonca

Description

@zonca

It is nice you have docstrings in the functions.
It would be useful to use Sphynx to automatically extract those docstrings and build documentation, see for example PySM:
https://github.com/galsci/pysm/tree/main/docs

You can configure readthedocs so that at documentation is built at every commit: https://docs.readthedocs.io/en/stable/tutorial/index.html

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions