Skip to content

A fast, helpful, and open-source document parser

chore: trim impl/trait impl from api reference

Clelia (Astra) Bertellif3799f39ab06
diff --git a/.github/workflows/sync-docs.yml b/.github/workflows/sync-docs.yml
index 5ea2610..df10675 100644
--- a/.github/workflows/sync-docs.yml
+++ b/.github/workflows/sync-docs.yml
@@ -12,6 +12,9 @@ jobs:
- name: Checkout source repo
uses: actions/checkout@v4
+ - name: Install uv
+ uses: astral-sh/setup-uv@v8
+
- name: Install Rust nightly
uses: dtolnay/rust-toolchain@nightly
diff --git a/scripts/generate-api-docs.sh b/scripts/generate-api-docs.sh
index 611b5ff..79e67cb 100755
--- a/scripts/generate-api-docs.sh
+++ b/scripts/generate-api-docs.sh
@@ -13,6 +13,7 @@ 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'
diff --git a/scripts/strip-impls-from-api-docs.py b/scripts/strip-impls-from-api-docs.py
new file mode 100755
index 0000000..dc4de65
--- /dev/null
+++ b/scripts/strip-impls-from-api-docs.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.10"
+# dependencies = []
+# ///
+import re
+
+DOCS_DIR = "./docs/src/content/docs/liteparse"
+TMP_DIR = f"{DOCS_DIR}/.api-tmp"
+
+path = f"{TMP_DIR}/README.md"
+text = open(path).read()
+text = re.sub(r"#{2,} Implementations\n.*?(?=\n#{2,} )", "", text, flags=re.DOTALL)
+text = re.sub(
+ r"#{2,} Trait Implementations\n.*?(?=\n#{2,} )", "", text, flags=re.DOTALL
+)
+open(path, "w").write(text)