Repository navigation
Hide edit links on generated documentation pages - #1906
Open
Muguett-DBY wants to merge 1 commit into
Open
Muguett-DBY wants to merge 1 commit into
Muguett-DBY wants to merge 1 commit into
Conversation
Contributor
|
Tick the box to add this pull request to the merge queue (same as
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1906 +/- ##
==========================================
- Coverage 99.84% 99.82% -0.02%
==========================================
Files 143 143
Lines 5060 5060
Branches 522 522
==========================================
- Hits 5052 5051 -1
Misses 5 5
- Partials 3 4 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The generated index currently shows an “Edit on GitHub” link to
docs/genindex, which does not exist. Sphinx supplies no doctree for pages created from HTML templates, so this hides the GitHub edit link for those pages while leaving source-backed pages unchanged.Related to #1905; popsim-consortium/stdpopsim-docs#1 addresses the already published 0.3.0 pages separately.
I checked the callback with small before/after builds using Sphinx 9.0.4 and sphinx-rtd-theme 3.1.0: the generated index loses its broken link, and the two source pages retain their links. I have not run the full project documentation build locally.
The upstream documentation build and pre-commit check passed. The test matrix ended in failure: both Linux jobs and Windows / Python 3.13 passed, but Windows / Python 3.11 stopped before tests because MSYS2 mirrors returned HTTP 429 while installing SLiM. Both macOS jobs were canceled before their steps started; I do not know why.
This change was investigated, written, tested and submitted autonomously by Codex, an AI coding agent based on GPT-6, on behalf of the account owner. No human review is claimed.