As discussed in #18, we could add auto-generated API docs to this project.
As done for Canals, I recommend using MkDocs (the Material theme is especially featureful) and host the result on GitHub Pages. It's generally very simple, and as long as the docstrings are well formatted with the Google style (see this SO answer) it's maintenance-free. Such docs can be fully automated with a simple GitHub workflow on every push to master.
MkDocs has great documentation, and in case of need an example of how to do create and deploy these API docs can be seen in Canals: the configuration lives in mkdocs.yml (made a bit complex by the mermaid support), the docs are found in the docs folder, and here is the workflow that deploys the docs.
As discussed in #18, we could add auto-generated API docs to this project.
As done for Canals, I recommend using MkDocs (the Material theme is especially featureful) and host the result on GitHub Pages. It's generally very simple, and as long as the docstrings are well formatted with the Google style (see this SO answer) it's maintenance-free. Such docs can be fully automated with a simple GitHub workflow on every push to
master.MkDocs has great documentation, and in case of need an example of how to do create and deploy these API docs can be seen in Canals: the configuration lives in
mkdocs.yml(made a bit complex by themermaidsupport), the docs are found in thedocsfolder, and here is the workflow that deploys the docs.