fix: rustdoc now with indices and a better make target name (#1221)

spiraldb · Nov 5, 2024 · ccd3341 · ccd3341
1 parent 6a3cb7b
commit ccd3341
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 3 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -19,8 +19,15 @@ help:
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
-full-html: html rust-html
+python-and-rust-html: html rust-html
 	true  # need a non-empty rule to prevent matching the %: rule.
 
 rust-html:
-	cargo doc --no-deps --workspace --all-features --target-dir $(BUILDDIR)/html/rust
+	RUSTDOCFLAGS="--enable-index-page -Z unstable-options" cargo doc \
+		--no-deps \
+		--workspace \
+		--exclude bench-vortex \
+		--exclude xtask \
+		--all-features \
+		--target-dir \
+		$(BUILDDIR)/html/rust
diff --git a/docs/README.md b/docs/README.md
@@ -18,7 +18,7 @@ uv run make html
 Build the Python and Rust docs and place the rust docs at `_build/rust/html`:
 
 ```
-uv run make full-html
+uv run make python-and-rust-html
 ```
 
 ## Viewing