Skip to content

fix(docs): repair Python API cross-references - #1257

Merged
paleolimbot merged 2 commits into
apache:mainfrom
paleolimbot:codex/fix-python-cross-references
Sep 11, 2026
Merged

fix(docs): repair Python API cross-references#1257
paleolimbot merged 2 commits into
apache:mainfrom
paleolimbot:codex/fix-python-cross-references

Conversation

@paleolimbot

@paleolimbot paleolimbot commented Sep 10, 2026

Copy link
Copy Markdown
Member

Adds explicit mkdocs-autorefs configuration and converts Python API docstrings to mkdocstrings reference-style links. Documents the supported syntax for future contributors and relies on the existing strict documentation build for validation.

Validation: ci/scripts/build-docs.sh

closes #272

@paleolimbot
paleolimbot marked this pull request as ready for review September 11, 2026 15:37
@paleolimbot
paleolimbot merged commit 1d57b82 into apache:main Sep 11, 2026
5 checks passed
@paleolimbot
paleolimbot deleted the codex/fix-python-cross-references branch September 11, 2026 18:45
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.

Python cross-references are broken

2 participants