search

IzunaDevs / nsfw_dl

Python 3 package for downloading images.
MIT License
4 stars 4 forks source link

Add documentations to this package. #4

Open AraHaan opened 7 years ago

AraHaan commented 7 years ago

I also think we should add documentations to this package after we take care of the command line, followed by setup.py later. Documentations might help people with both the command line and using it in their own python code directly. For this I dont really mind which one they use as in the end they should be able to get the same result. Not sure if the documentations should be written in markdown on rST like discord.py is so we can use (shpinx) and get similar looking docs like the rewrite ones?

I am currently not worried on format but more on the looks.

Martmists-GH commented 7 years ago

We use sphinx for all our projects documentation as readthedocs.io can autobuild on commits to automatically update.

AraHaan commented 7 years ago

I think that should be good for the docs. 👌