-
Notifications
You must be signed in to change notification settings - Fork 95
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
Add examples of using BIOM executable to the website #735
Comments
There's a manpage? @colinbrislawn I am strongly in favor of expanding the accessible examples and documentation, and would eagerly accept PRs on this |
Maybe it's not called a manpage...
The documentation is already really good for all the biom CLI, so how can we featuer that on the http://biom-format.org website? |
I think the best long term solution would be to at release, dynamically create a page, per command, based off the docstrings within the commands. Would you be interested in taking point on that? |
I agree that reusing the CLI documentation and generating it dynamically would be excellent. While Click has great support for CLI help, I'm not sure how best to pull that into a format which could be rendered on the |
Thanks to #3, there are excellent examples of using the
biom
API. There are also excellent examples in the manpage, but not on the website!For example, the command
biom normalize-table
is well documented in the manpage, but is never mentioned on the website. Because the website is accessible than the manpage for new linux users, I suggest we take the excellent documentation in the manpage, and put it somewhere online.Where on the website can we feature the examples in the manpage?
EDIT: If it's on the website and I'm totally missing something, please let me know!
EDIT2: This question in the Qiime forum would be addressed by this fix.
The text was updated successfully, but these errors were encountered: