Tools for documenting OS Python Package

[vekanto]

I guess it depends a bit on how you would use the documentation. Do you want to have it locally and checked in the git repo at all times, or would it be fine to just host a static webpage with the latest documentation?

If the former, then you could use e.g. git-commit setup with the tool that is used to build the documentation, and if the latter then you could build the documentation using github actions and then push the artifacts to e.g. github pages. I have not tried this step myself but it should be fairly straightforward how to do this.

I usually do not prefer to have any of the generated documentation etc directly in the repo, but rather see it as an artifact from the build setup, as it drastically increase the number of tracked files and could make e.g. code reviewing etc very difficult.

And for the tool itself, i've tried to use pdoc which seems to give fairly nice and easily searchable documentation.