Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentations to this package. #4

Open
AraHaan opened this issue Aug 30, 2017 · 2 comments
Open

Add documentations to this package. #4

AraHaan opened this issue Aug 30, 2017 · 2 comments

Comments

@AraHaan
Copy link
Member

AraHaan commented Aug 30, 2017

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
Copy link
Member

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

@AraHaan
Copy link
Member Author

AraHaan commented Sep 19, 2017

I think that should be good for the docs. 👌

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants