postmodern-python icon indicating copy to clipboard operation
postmodern-python copied to clipboard

Adding docs to the repo?

Open jakob1379 opened this issue 6 months ago • 1 comments

After heavily experimenting with mkdocs, I believe it could be a nice addition to this template, promoting easy documentation for the python projects.

Since you have already added ci it would not take much to add this and automate the deployment of it, but I am unsure if this will make the template feel too heavy. An alternative approach would be to have a poe task to instantiate the documentation if one would like to add it?

jakob1379 avatar Jun 11 '25 08:06 jakob1379

I thought of this but left it out because I thought it was a bit heavy. Most of the stuff in this repo is stuff that virtually everyone using Python will want, whereas online docs I feel is more specific to open source projects? Although to be fair I did add publishing to PyPI, which is probably much the same.

I have a full mkdocs setup in another repo here, here and here.

Not totally averse to it, but not sure the extra complexity is worth it...

carderne avatar Jun 11 '25 08:06 carderne