TezRomacH / python-package-template

🚀 Your next Python package needs a bleeding-edge project structure.
MIT License
1.09k stars 124 forks source link

Documentation ready package #852

Open VDuda opened 1 year ago

VDuda commented 1 year ago

🚀 Feature Request

A documentation generator as part of this package. Would be nice to have a discussion on which generator to you; I default to ReadTheDocs, but I'm sure there are more modern generators nowadays? Would be happy to implement this feature.

🔈 Motivation

I figured as part of a modern package stack you should have a documentation portal as the package grows.

🛰 Alternatives

Reading through the source code, googling, git

📎 Additional context

A few doc generators that came to mind

github-actions[bot] commented 1 year ago

Hello @VDuda, thank you for your interest in our work!

If this is a bug report, please provide screenshots and minimum viable code to reproduce your issue, otherwise we can not help you.