issues
search
broadinstitute
/
cromwell-tools
A collection of Python clients and accessory scripts for interacting with the Cromwell
https://cromwell-tools.readthedocs.io
BSD 3-Clause "New" or "Revised" License
22
stars
9
forks
source link
Fix and improve docs
#72
Closed
rexwangcc
closed
5 years ago
rexwangcc
commented
5 years ago
Purpose
https://broadinstitute.atlassian.net/jira/software/projects/GH/boards/530?selectedIssue=GH-236
Changes
Add
--version
argument to the CLI.
Fix a minor issue with the docstrings of
wait
function in API.
Improve the main readme:
Add a few sub-sections to the
development
section.
Fix some outdated docs.
Start to render Jupyter notebooks in Sphinx-generated docs.
Add a whole new CLI quickstart to the documentation.
Review Instructions
You can
preview
the brand new docs here:
https://cromwell-tools.readthedocs.io/en/rex-fix-and-improve-docs/index.html
Note the rendered Jupyter Notebooks are:
https://cromwell-tools.readthedocs.io/en/rex-fix-and-improve-docs/Tutorials/Quickstart/api_quickstart.html
and
https://cromwell-tools.readthedocs.io/en/rex-fix-and-improve-docs/Tutorials/Quickstart/cli_quickstart.html
Purpose
Changes
--version
argument to the CLI.wait
function in API.development
section.Review Instructions