Repository navigation
docs: stop the flaky linkcheck 429 failing the docs build - #140
Merged
Merged
Conversation
The Documenter linkcheck step occasionally fails on main (and any PR) with 'linkcheck https://community.epinowcast.org status: 429' — the epinowcast Discourse forum rate-limits CI requests under the full build. 429 is not in the warnonly list, so linkcheck errors are fatal and the build terminates before rendering. This adds the forum to LINKCHECK_IGNORE, matching the existing pattern for external sites that intermittently time out / rate-limit under CI linkcheck. The link itself is stable; only the throttled check flakes.
Contributor
Try this Pull Request!Option 1: Julia Package ManagerOpen Julia and type: import Pkg
Pkg.activate(temp=true)
Pkg.add(url="https://github.com/EpiAware/ModifiedDistributions.jl", rev="fix/docs-linkcheck-epinowcast")
using ModifiedDistributionsOption 2: Local CheckoutIf you have the repo locally: git checkout fix/docs-linkcheck-epinowcast
julia --project=. -e "using Pkg; Pkg.instantiate()" |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
|
📖 Documentation preview is ready! View the docs for this PR at: https://EpiAware.github.io/ModifiedDistributions.jl/previews/PR140/ This preview will be updated automatically when you push new commits. |
seabbs
approved these changes
Aug 12, 2026
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.
Problem
The Documenter
linkcheckstep intermittently fails the docs build onmain(and every open PR) with:The epinowcast Discourse forum rate-limits CI requests, returning HTTP 429.
build_docs(viaEpiAwarePackageTools) passeswarnonly = [:docs_block, :missing_docs, :autodocs_block, :cross_references]— not:linkcheck— so the 429 is fatal and the build aborts before rendering. It's intermittent: the Aug 3 build (run 30834932552) passed on the same code.Fix
Add
community.epinowcast.orgtoLINKCHECK_IGNOREindocs/docs_config.jl, matching the existing entries for other external sites that intermittently time out / rate-limit under CI linkcheck (code.visualstudio.com,github.com/go-task/task/releases). The linked forum pages are stable; only the throttled check flakes.Notes (non-blocking — pre-existing warnings, not build failures)
While investigating, the docs build also emits these
@ref/@examplewarnings that are not fatal:docs/src/lib/public.mdcannot resolve@refforModifiedDistributions.update/prune/splice(referenced from theeffective_intensitydocstring atsrc/Transformed.jl:291-292but not in the@docsblocks).@reffor external built-in symbols (Distributions.gradlogpdf,Base.missing, etc.) indocs/src/lib/internals.md.@exampleblock ondocs/src/lib/public.md.These don't break the build and are out of scope here.