API Reference zeal_docsets v#0.1.7

Copy Markdown View Source

Modules

ZealDocsets generates offline documentation bundles (docsets) for Zeal and Dash from the direct Hex dependencies of any Mix project.

Shared argument parsing and report rendering helpers used by mix zeal.docs.

Represents a resolved package selected for docset generation.

Orchestrates the construction of a .docset bundle for a single dependency.

Utility helpers for extracting text and attributes from Floki-parsed HTML.

Fetches package metadata from the Hex.pm API.

Downloads and mirrors documentation from hexdocs.pm using a BFS crawler.

Builds the SQLite search index (docSet.dsidx) for a Zeal/Dash docset.

Reads a Mix project's direct dependencies and their locked versions.

Coordinates dependency selection and docset generation for a target project.

Manages the workspace directory used for downloads and generated docsets.

Mix Tasks

Generates Zeal/Dash-compatible docsets for the direct Hex dependencies of the current Mix project, with optional extra Hex packages requested explicitly.