Skip to content

nf-docs v0.2.0

Choose a tag to compare

View all tags
@ewels ewels released this 03 Mar 23:02
· 8 commits to main since this release
v0.2.0
51d6335
This commit was signed with the committer’s verified signature.
ewels Phil Ewels
SSH Key Fingerprint: 2vJRTr18pF9TOa8Stz1soprPmuVQ/KDdA3vECX6DaDg
Verified
Learn about vigilant mode.

Added

  • New table output format (-f table) with terraform-docs-style Markdown tables and marker
    injection for embedding generated docs into existing README files
  • Template-based selective section rendering for the table format, allowing users to choose which
    sections to include
  • Groovydoc @param and @return tag descriptions are now applied to process inputs and outputs
  • Support for Nextflow typed syntax (val(x), path(x), tuple val(x), path(y), etc.) when
    parsing process inputs and outputs
  • Enriched bare typed outputs from .nf source files with proper type and name extraction
  • Pattern restriction display in HTML parameter cards
  • nf-fgsv added as an example pipeline, with YAML and table example outputs for all pipelines

Fixed

  • Parameters not displaying in HTML output due to README heading ID collisions with parameter IDs
  • Parsing of bare typed outputs and ? nullable type from LSP hover content
  • Use a valid GitHub markdown admonition type in README

Full Changelog: v0.1.0...v0.2.0

Assets 2
Loading