ZealDocsets.Workspace (zeal_docsets v0.1.7)

Copy Markdown View Source

Manages the workspace directory used for downloads and generated docsets.

The workspace has the following layout:

<root>/
├── downloads/   ← mirrored hexdocs HTML/assets
└── output/      ← generated .docset bundles

Summary

Functions

ensure!(root)

Ensures the workspace directory and its required subdirectories exist.

Functions

ensure!(root)

@spec ensure!(Path.t()) :: Path.t()

Ensures the workspace directory and its required subdirectories exist.

Expands root to an absolute path, creates downloads/ and output/ subdirectories if they do not exist, and returns the expanded root.

Raises on filesystem errors.