Is there a good way to do automated docs?

[mgancita]

Is there a good way to do automated docs?

[Mgancita]

I've used Sphinx in the past (but not in a while) so I'm down to try it! My main concern with this is to have the functionality while keeping it easy to use. If that's possible then I'm all for it but I definitely worry about this project getting bloated with features like other pypackage repos.

[MaKaNu]

I am completely on your side. I think using Sphinx for that get's another Dependency into the project, for just extracting the docstring and create an Markdown of it. I wish there is another better and KISS solution to create MD from Docstring.

[Mgancita]

Yea I want to look around for this as the more I think about it, it would be a really cool functionality but wish it was simpler. By what I remember, Sphinx is very extensible but doesn't lend itself well to simple projects

[MaKaNu]

I keep my eyes open to simpler solutions. The result does also not look that perfect as expected: https://makanu.github.io/rainbowdrinkinggame/packages/rainbowdrinkinggame/