Skip to content
This repository has been archived by the owner on Mar 1, 2018. It is now read-only.

Provide proper documentation #6

Open
jonDel opened this issue Dec 2, 2016 · 2 comments
Open

Provide proper documentation #6

jonDel opened this issue Dec 2, 2016 · 2 comments
Labels
hacktoberfest

Comments

@jonDel
Copy link

jonDel commented Dec 2, 2016

Provide proper documentation for this package. Suggestion:

  • Use sphinx and readthedocs.io for automatic documentation building online at each commit.
@cuducos
Copy link
Collaborator

cuducos commented Dec 7, 2016

That'd be awsome. I d never generate docs through Sphinx. Can you help us get started and then I can fill the blanks?

@jonDel
Copy link
Author

jonDel commented Dec 7, 2016

I used it before (in my pip packages and serenata-toolbox), in the context of a package, but I think it will be pretty straightforward to translate it into only modules.

@jonDel jonDel mentioned this issue Dec 7, 2016
Open
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cuducos @jonDel