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

Generate documentation automatically #4

Closed
mtazzari opened this issue Dec 9, 2019 · 2 comments
Closed

Generate documentation automatically #4

mtazzari opened this issue Dec 9, 2019 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@mtazzari
Copy link
Collaborator

mtazzari commented Dec 9, 2019

Generate documentation automatically, e.g. using a tool like sphinx, embedding the docstrings provided in the code.
Have a look at how we do it in galario: https://github.com/mtazzari/galario/tree/master/docs

It needs #3 to generate docs automatically after each push to master

@mtazzari mtazzari added the documentation Improvements or additions to documentation label Dec 9, 2019
@mtazzari mtazzari modified the milestones: 1.0b, 1.0.beta Dec 9, 2019
@mtazzari
Copy link
Collaborator Author

Requires the repo to be public in order for doctr tool to pull the code and push to github pages.

@mtazzari
Copy link
Collaborator Author

mtazzari commented Jan 17, 2020

Fixed by #23

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

No branches or pull requests

1 participant