Krukov / cashews

Cache with async power
MIT License
406 stars 25 forks source link

Documenting with sphinx? #199

Open viktorfreiman opened 8 months ago

viktorfreiman commented 8 months ago

Is there any plans on start using sphinx and auto generating api documentation instead of having to manual type in the readme?

It would be nice to move the docs over to something like readthedocs and make it autobuild on master

Krukov commented 8 months ago

Hello.

Yes that is a thing that I thought about a long time ago. But I still have a doubt that it is better than just Readme. I usually try to find an answer in a readme and only than opening a "full documentation"