Generate API documentation for Nextflow pipelines by querying the Nextflow Language Server

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for ewels from gravatar.com ewels

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: Apache-2.0
    SPDX License Expression
  • Author: nf-docs contributors
  • Tags nextflow , documentation , bioinformatics , pipeline , lsp
  • Requires: Python >=3.10
  • Provides-Extra: dev , screenshots
Classifiers
Report project as malware

Project description

nf-docs

Generate beautiful API documentation for Nextflow pipelines

Python 3.10+ License

nf-docs demo

Full documentation →

Choose from 4 different output formats:

HTML

  • Single-file output
  • Share anywhere, even offline
  • Full-text search built in

Markdown

  • Multiple files or tables by section
  • Perfect for static site generators

JSON / YAML

  • Machine-readable output
  • Build custom integrations
  • CI/CD friendly

What is nf-docs?

[!IMPORTANT] This is not an official Nextflow project. It's a fun side-project by Phil Ewels. Please use at your own risk :)

Information is pulled from multiple sources to construct the docs (each only if available):

  • README.md - Pipeline overview and description
  • nextflow.config - Runtime configuration defaults
  • nextflow_schema.json - Typed input parameters with descriptions and validation rules
  • Language Server - Processes, workflows, functions with their Groovydoc comments
  • meta.yml - nf-core module metadata (tools, keywords, authors)

The documentation for workflows, processes and functions is relatively unique. nf-docs extracts this from your Nextflow pipelines by querying the Nextflow Language Server. It produces structured API documentation similar to Sphinx for Python or Javadoc for Java.

Examples and docs

See https://ewels.github.io/nf-docs

Quick Start

With uv:

uvx nf-docs generate ./my_pipeline

With pip:

# Install
pip install nf-docs

# Generate HTML documentation
nf-docs generate ./my_pipeline

With Bioconda (requires channel setup):

pixi global install nf-docs
# or
conda install nf-docs

That's it! Open docs/index.html in your browser.

Development

See CONTRIBUTING.md for development setup, testing, and contribution guidelines.

License

Apache 2.0 - see LICENSE for details.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for ewels from gravatar.com ewels

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License Expression: Apache-2.0
    SPDX License Expression
  • Author: nf-docs contributors
  • Tags nextflow , documentation , bioinformatics , pipeline , lsp
  • Requires: Python >=3.10
  • Provides-Extra: dev , screenshots
Classifiers

Release history Release notifications | RSS feed

This version

0.2.1

0.2.0

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nf_docs-0.2.1.tar.gz (115.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nf_docs-0.2.1-py3-none-any.whl (107.2 kB view details)

Uploaded Python 3

File details

Details for the file nf_docs-0.2.1.tar.gz.

File metadata

  • Download URL: nf_docs-0.2.1.tar.gz
  • Upload date:
  • Size: 115.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nf_docs-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2ebdd51859b99c179dd7768280b4249a372eaac7012339c92c0774146fa8acde
MD5 29237af3caaf150786d1e2cb88564795
BLAKE2b-256 dcadddc0e66d32b681fe07cae87d6a7dc8ce65387aa79184dc4e617b8a23c41c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nf_docs-0.2.1.tar.gz:

Publisher: publish.yml on ewels/nf-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nf_docs-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: nf_docs-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 107.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nf_docs-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5aa711fb04d61e114d014632af96ea2f8be8100eb00c66f611ccf675a70b2a4c
MD5 14ac6b51ebd06992444e02c64339804b
BLAKE2b-256 b01b7a0b029e54e13368087343115b350859838951d13f0a82cbc467fa087a4e

See more details on using hashes here.

Provenance

The following attestation bundles were made for nf_docs-0.2.1-py3-none-any.whl:

Publisher: publish.yml on ewels/nf-docs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page