Skip to content

Releases: ewels/nf-docs

nf-docs v0.2.1

23 Mar 19:17
f5b4213

Choose a tag to compare

Fixed

  • Configure additional files for PyPI package distribution (#6)
  • Fix ty typecheck errors with explicit dict type annotations (#7)

nf-docs v0.2.0

03 Mar 23:02
51d6335

Choose a tag to compare

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

nf-docs v0.1.0

20 Feb 19:51
3670308

Choose a tag to compare

Initial release of nf-docs.

Added

  • nf-docs generate command to extract and render pipeline documentation in HTML, JSON, YAML, and
    Markdown formats
  • nf-docs inspect command for a dry-run summary of what nf-docs finds in a pipeline
  • nf-docs download-lsp and nf-docs clear-cache utility commands
  • Extraction of pipeline inputs from nextflow_schema.json and 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.yml support 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.yaml for persistent defaults

Full Changelog: https://github.com/ewels/nf-docs/commits/v0.1.0