docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289
docs: link cwl-docker-extract from CWL_SINGULARITY_CACHE help (#1537)#2289arimu1 wants to merge 2 commits into
Conversation
| f"[{bt}]dockerFile[/] images will also be searched for and stored here", | ||
| f"[{bt}]dockerFile[/] images will also be searched for and stored here. " | ||
| f"Images can be pre-pulled into this directory using " | ||
| f"[link=https://github.com/common-workflow-language/cwl-utils#pull-the-all-referenced-software-container-images]cwl-docker-extract[/] from cwl-utils", |
There was a problem hiding this comment.
Probably better to link to https://pypi.org/project/cwl-utils/ or https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract
|
Good call — switched the link to the stable cwl-utils docs page: https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract (confirmed the |
f949b67 to
09ee1f1
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2289 +/- ##
=======================================
Coverage 85.18% 85.18%
=======================================
Files 46 46
Lines 8593 8593
Branches 2011 2011
=======================================
Hits 7320 7320
Misses 807 807
Partials 466 466 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
1695a60 to
01b644b
Compare
…-workflow-language#1537) Issue common-workflow-language#1537 asked to document CWL_SINGULARITY_CACHE and link to the cwl-utils "pull all referenced software container images" reference. The variable itself is now listed in the environment-variable table (shown in `cwltool --help` and the Sphinx CLI docs), but it did not point users at how to pre-populate the cache. Add a link to cwl-utils' cwl-docker-extract, using the existing [link=...] markup so it renders both as a terminal hyperlink and as a reStructuredText link in the generated docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…workflow-language#1537) Per review feedback, link to the stable cwl-utils documentation page (https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract) instead of the GitHub README anchor.
01b644b to
cb0e671
Compare
|
Updated per review — the link now points to https://cwl-utils.readthedocs.io/en/latest/#cwl-docker-extract instead of the GitHub README anchor. Also rebased onto current |
Summary
Addresses #1537, which asked to document
CWL_SINGULARITY_CACHEand link to the cwl-utils Pull the all referenced software container images reference.The variable is now listed in the environment-variable table (introduced when the CLI groups were reorganized), so it appears in
cwltool --helpand the autogenerated Sphinx CLI docs. What was still missing is the second half of the request: pointing users at how to pre-populate that cache.Change
Extend the
CWL_SINGULARITY_CACHEentry incwltool/argparser.pyto link to cwl-utils'cwl-docker-extract, which pre-pulls all referenced container images into a directory. It uses the existing[link=...]markup (same as theORCIDentry), so it renders correctly in both outputs:cwltool --help(terminal hyperlink):Sphinx CLI docs (reStructuredText):
Verified the cwl-utils anchor still resolves, the parser still builds, and
black/flake8are clean. Docs-only string change. Once this lands, #1537 can be closed.This change was produced with the assistance of Claude Code (model: Claude Opus). It was reviewed by a human before submission.