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

Document Python packages #96

Open
jonrkarr opened this issue Jul 2, 2021 · 1 comment
Open

Document Python packages #96

jonrkarr opened this issue Jul 2, 2021 · 1 comment

Comments

@jonrkarr
Copy link

jonrkarr commented Jul 2, 2021

This is a great resource. Documentation for the all of Python packages for each of the simulation tools would make this much easier to use.

@pauleve
Copy link
Contributor

pauleve commented Jul 2, 2021

Yes, we need to push our efforts on the documentation...
Actually, many Python modules are already documented. We should probably link the documentation in the description of the tools at https://colomoto.github.io/colomoto-docker/
Then, for tools without documentation, we could at least generate a basic one with readthedocs, even without complete docstrings. I'm hoping to find the time for working on the documentation during the summer.

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

No branches or pull requests

2 participants