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

Review: add documentation #4

Closed
Tracked by #12
cthoyt opened this issue Aug 23, 2022 · 2 comments
Closed
Tracked by #12

Review: add documentation #4

cthoyt opened this issue Aug 23, 2022 · 2 comments

Comments

@cthoyt
Copy link

cthoyt commented Aug 23, 2022

This code currently does not contain any documentation. There are a few ways to go about doing that to make it useful for potential users:

  1. Add a "getting started" example to the README
  2. Use sphinx to auto-generate documentation based on docstrings and weave them together with tutorials

See https://www.youtube.com/watch?v=azf6yzuJt54 for motivation on better documentation - there should be several parts to documentation:

  1. Technical documentation (i.e., all functions are self-explanatory what they do based on their docstrings)
  2. High-level documentation (i.e., tutorials for the thing 99% of users will want to do with your package after reading your paper)
@cthoyt cthoyt changed the title Review: documentation Review: add documentation Aug 23, 2022
@r-costa r-costa closed this as completed Oct 30, 2022
@cthoyt
Copy link
Author

cthoyt commented Nov 14, 2022

This was not done

@r-costa
Copy link
Owner

r-costa commented Dec 2, 2022

Thank you for highlighting this aspect. We now provide the ReadTheDocs https://sbml2hyb.readthedocs.io/en/latest/# .

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