Releases: ewels/nf-docs
Releases · ewels/nf-docs
nf-docs v0.2.1
nf-docs v0.2.0
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
@paramand@returntag 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
.nfsource 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
nf-docs v0.1.0
Initial release of nf-docs.
Added
nf-docs generatecommand to extract and render pipeline documentation in HTML, JSON, YAML, and
Markdown formatsnf-docs inspectcommand for a dry-run summary of what nf-docs finds in a pipelinenf-docs download-lspandnf-docs clear-cacheutility commands- Extraction of pipeline inputs from
nextflow_schema.jsonand config parameters from
nextflow.config - Process, workflow, and function documentation via the Nextflow Language Server (LSP), including
Groovydoc docstrings and typed I/O declarations - nf-core
meta.ymlsupport for enriched module and subworkflow documentation - Git-aware source code deep links for GitHub, GitLab, and Bitbucket
- XDG-compliant caching keyed by content hash and package version, with automatic invalidation
- User config file at
~/.config/nf-docs/config.yamlfor persistent defaults
Full Changelog: https://github.com/ewels/nf-docs/commits/v0.1.0