Skip to content

docs: Fix cross-references, update tutorial, and enforce strict mkdocs build - #538

Merged
aarmey merged 1 commit into
mainfrom
docs/fix-links-and-strict-build
Sep 4, 2026
Merged

docs: Fix cross-references, update tutorial, and enforce strict mkdocs build#538
aarmey merged 1 commit into
mainfrom
docs/fix-links-and-strict-build

Conversation

@aarmey

@aarmey aarmey commented Sep 4, 2026

Copy link
Copy Markdown
Member

Summary of changes

  • Fix broken RISE.* cross-references in docs/component_ordering.md and docstrings to scrise.*
  • Update docs/tutorial.md installation instructions to pip install scrise
  • Add missing API documentation sections for annotation_alignment, plotting.annotation_alignment, and opq
  • Add component_ordering.md to docs/index.md
  • Enforce --strict in mkdocs build to prevent broken documentation links in CI

@aarmey
aarmey merged commit 1a2cb51 into main Sep 4, 2026
6 checks passed
@aarmey
aarmey deleted the docs/fix-links-and-strict-build branch September 4, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant