python-package-template icon indicating copy to clipboard operation
python-package-template copied to clipboard

Documentation ready package

Open VDuda opened this issue 2 years ago • 1 comments

🚀 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

  • ReadTheDocs
  • Docusaurus
  • GitBook
  • Sphinx

VDuda avatar Jun 15 '23 12:06 VDuda

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.

github-actions[bot] avatar Jun 15 '23 12:06 github-actions[bot]