# `mix snakebridge.docs.manifest`
[🔗](https://github.com/nshkrdotcom/snakebridge/blob/v0.16.0/lib/mix/tasks/snakebridge.docs.manifest.ex#L1)

Generates a SnakeBridge docs manifest JSON file from Sphinx documentation artifacts.

Supports:
- `objects.inv` (Intersphinx inventory) for an inventory of documented objects
- optional HTML page extraction for:
  - a docs-nav filtered `full` profile (what the docs navigation links to)
  - a curated `summary` profile (fully-qualified object references in page text)

## Usage

    mix snakebridge.docs.manifest --library <pkg> --inventory <objects.inv> --out priv/snakebridge/<pkg>.docs.json

    mix snakebridge.docs.manifest --library <pkg> \
      --inventory <objects.inv> \
      --nav <api index url or path> \
      --nav-depth 1 \
      --summary <api index url or path> \
      --out priv/snakebridge/<pkg>.docs.json

You can also pass local paths instead of URLs.

The output JSON is intended to be committed so builds stay deterministic and
do not depend on network availability.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
