9f97f3abbe
CI - Node Bindings / Build darwin-arm64 (push) Waiting to run
CI - Node Bindings / Build darwin-x64 (push) Waiting to run
CI - Node Bindings / Test win32-x64-msvc (push) Blocked by required conditions
CI - Node Bindings / Build linux-arm64-gnu (push) Waiting to run
CI - Node Bindings / Build linux-x64-gnu (push) Waiting to run
CI - Node Bindings / Build linux-x64-musl (push) Waiting to run
CI - Node Bindings / Build win32-arm64-msvc (push) Waiting to run
CI - Node Bindings / Build win32-x64-msvc (push) Waiting to run
CI - Node Bindings / Test darwin-arm64 (push) Blocked by required conditions
CI - Node Bindings / Test darwin-x64 (push) Blocked by required conditions
CI - Node Bindings / Test linux-x64-gnu (push) Blocked by required conditions
CI - Node Bindings / Test linux-x64-musl (push) Blocked by required conditions
CI - Node Bindings / Test win32-arm64-msvc (push) Blocked by required conditions
CI - Python Bindings / Build aarch64-pc-windows-msvc (push) Waiting to run
CI - Python Bindings / Build x86_64-pc-windows-msvc (push) Waiting to run
CI - Python Bindings / Build x86_64-apple-darwin (push) Waiting to run
CI - Python Bindings / Build aarch64-apple-darwin (push) Waiting to run
CI - Python Bindings / Build aarch64-unknown-linux-gnu (push) Waiting to run
CI - Python Bindings / Test x86_64-apple-darwin (push) Blocked by required conditions
CI - Python Bindings / Test aarch64-apple-darwin (push) Blocked by required conditions
CI - Python Bindings / Test x86_64-unknown-linux-gnu (push) Blocked by required conditions
CI - Python Bindings / Test x86_64-unknown-linux-musl (push) Blocked by required conditions
CI - Python Bindings / Test aarch64-pc-windows-msvc (push) Blocked by required conditions
CI - Python Bindings / Test x86_64-pc-windows-msvc (push) Blocked by required conditions
CI / build-and-test (macos-26-intel) (push) Waiting to run
CI / build-and-test (macos-latest) (push) Waiting to run
CI / build-and-test (windows-11-arm) (push) Waiting to run
CI / build-and-test (windows-latest) (push) Waiting to run
CI - Python Bindings / sdist (push) Failing after 1s
CI - Python Bindings / Build x86_64-unknown-linux-musl (push) Failing after 1s
CI / fmt (push) Failing after 1s
E2E Output Validation / compare-outputs (push) Failing after 1s
Sync Docs to Developer Hub / sync-docs (push) Failing after 1s
CI - Python Bindings / Build x86_64-unknown-linux-gnu (push) Failing after 1s
CI - WASM Bindings / Build WASM (push) Failing after 0s
CI / clippy (push) Failing after 1s
CI / build-and-test (ubuntu-latest) (push) Failing after 0s
CI - WASM Bindings / Edge runtime PDF parse test (push) Has been skipped
CI - WASM Bindings / Browser PDF parse test (push) Has been skipped
E2E Output Validation / upload-dataset (push) Waiting to run
Deploy Demo to GitHub Pages / deploy (push) Failing after 1s
CI / build-docker-image (push) Failing after 3s
34 lines
964 B
Bash
Executable File
34 lines
964 B
Bash
Executable File
#!/usr/bin/env bash
|
|
# Generates API reference docs from rustdoc JSON via rustdoc-md and outputs
|
|
# a single Starlight-compatible markdown file with frontmatter.
|
|
set -euo pipefail
|
|
|
|
DOCS_DIR="./docs/src/content/docs/liteparse"
|
|
TMP_DIR="${DOCS_DIR}/.api-tmp"
|
|
OUT_FILE="${DOCS_DIR}/api.md"
|
|
|
|
# Generate rustdoc JSON and convert to markdown
|
|
mkdir -p $TMP_DIR
|
|
cd crates/liteparse/
|
|
cargo +nightly rustdoc --lib -- -Z unstable-options --output-format json
|
|
cd ../../
|
|
rustdoc-md --path ./target/doc/liteparse.json --output ${TMP_DIR}/README.md
|
|
./scripts/strip-impls-from-api-docs.py
|
|
|
|
# Prepend Starlight frontmatter to the generated README
|
|
cat > "${OUT_FILE}" <<'FRONTMATTER'
|
|
---
|
|
title: API Reference
|
|
description: API reference for the liteparse Rust crate. Types are shared across Node.js, Python, and WASM bindings.
|
|
sidebar:
|
|
order: 6
|
|
---
|
|
FRONTMATTER
|
|
|
|
cat "${TMP_DIR}/README.md" >> "${OUT_FILE}"
|
|
|
|
# Clean up temp directory
|
|
rm -rf "${TMP_DIR}"
|
|
|
|
echo "Generated ${OUT_FILE}"
|