Skip to content

[DOC-5942] Fix build-directory-dependent API source links - #4413

Draft
sfc-gh-qding wants to merge 1 commit into
mainfrom
qding/DOC-5942-source-links
Draft

sfc-gh-qding wants to merge 1 commit into
mainfrom
qding/DOC-5942-source-links

Conversation

@sfc-gh-qding

Copy link
Copy Markdown
Collaborator

Summary

API reference Source links can include incorrect paths because the resolver uses the build working directory. Resolve paths relative to the repository root, unwrap properties and decorated methods consistently, and omit links for objects outside the repository.

Test plan

  • Nine regression tests pass on Python 3.11 and 3.13; repository pytest passes on 3.11.
  • Full Sphinx 5.0.2 HTML build: no warnings.
  • Checked 1,181 rendered source URLs for repository-relative paths.
  • Black checks for new files and git diff --check pass.
  • CI and review before merge.

Generated with Snowflake CoCo

Resolve source paths relative to the repository and test decorated methods and properties without importing Sphinx configuration.

Generated with [Snowflake CoCo](https://docs.snowflake.com/en/user-guide/cortex-code/cortex-code)

Co-authored-by: Snowflake CoCo <noreply@snowflake.com>
@sfc-gh-qding sfc-gh-qding self-assigned this Oct 3, 2026
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