Skip to content

Add generated documentation #216

@elliot-100

Description

@elliot-100

Coming back to this project after some time, I'm finding it a bit difficult to follow the existing documentation and think it would be good to publish API docs from docstrings, instead of the hand-written notes in README.

pdoc is probably the simplest - I have it working for Spond-classes, published to GitHub Pages.

I'll try to get it working in a branch as as proof-of-concept, to the extent developers can browse a local version.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions