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 #43

Open
kmkurn opened this issue Oct 11, 2015 · 2 comments
Open

Generate documentation #43

kmkurn opened this issue Oct 11, 2015 · 2 comments

Comments

@kmkurn
Copy link

kmkurn commented Oct 11, 2015

We have pretty good docstrings in our code and I think it's good to have documentation (auto-)generation. We can use Sphinx for this. The problem is, Sphinx uses reStructuredText markup so we probably need to learn it and convert our existing docstring to reST.

@wazaundtechnik
Copy link
Contributor

Consider using Inch-ci for documentation. However, no support for Python yet.

@kmkurn
Copy link
Author

kmkurn commented Oct 11, 2015

Looks cool. Too bad they don't support Python yet. Anyway I think we still need to be able to generate docs locally.

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

2 participants