Closed orbeckst closed 3 years ago
You can either host the docs on readthedocs (create the kda project there in order to grab the name until someone else does!) or as GitHub pages.
I recommend starting with a simple sphinx setup (do a sphinx-quickstart
in a docs directory) and then just keep adding.
I recently did this from scratch for propka (see https://github.com/jensengroup/propka/tree/master/docs) with minimal effort - see the rendered docs at https://propka.readthedocs.io/
Cookiecutter already gave you everything that you need — just add to your docs directory!
There should be basic documentation for the package, generated from the doc strings using sphinx.
The docs can also contain examples #6 .