Skip to content

🐛 Normalize conf.py codelinks projects - #2008

Open
kocaemre wants to merge 1 commit into
useblocks:masterfrom
kocaemre:issue-2006-conf-py-projects
Open

kocaemre wants to merge 1 commit into
useblocks:masterfrom
kocaemre:issue-2006-conf-py-projects

Conversation

@kocaemre

Copy link
Copy Markdown

Summary

  • Normalize src_trace_projects loaded from conf.py before src-trace reads a project.
  • Add a regression that builds a src-trace page from conf.py-only project config.
  • Add an Unreleased changelog entry for the crash fix.

Closes #2006.

Tests

  • RED: uv run poe test-codelinks tests/test_src_trace.py -k conf_py_projects_are_normalized_for_src_trace failed with KeyError: 'source_discover_config' before the fix.
  • GREEN: uv run poe test-codelinks tests/test_src_trace.py -k conf_py_projects_are_normalized_for_src_trace passed.
  • uv run poe test-codelinks tests/test_src_trace.py passed: 403 passed.
  • uv run poe lint passed.
  • uv run poe typecheck passed.
  • git diff --check passed.

Signed-off-by: Emre K <110906681+kocaemre@users.noreply.github.com>
@github-actions github-actions Bot added the pkg: sphinx-codelinks Concerns the sphinx-codelinks package (packages/sphinx-codelinks) label Sep 30, 2026
@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 sphinx-codelinks | 🛠️ Build #34864079 | 📁 Comparing 16e8c16 against latest (caea4b8)

  🔍 Preview build  

1 file changed
± changelog.html

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg: sphinx-codelinks Concerns the sphinx-codelinks package (packages/sphinx-codelinks)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

🐛 sphinx-codelinks: src_trace_projects set in conf.py alone crashes every src-trace build (KeyError: source_discover_config)

1 participant