Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

linkcheck: Update configuration defaults for Sphinx 8.0 #12630

Merged
merged 12 commits into from
Jul 20, 2024
Merged

linkcheck: Update configuration defaults for Sphinx 8.0 #12630

merged 12 commits into from
Jul 20, 2024

Conversation

jayaddison
Copy link
Contributor

Feature or Bugfix

  • Refactoring

Purpose

  • Updates some linkcheck builder configuration defaults as-communicated by the deprecation process for the Sphinx v8.0 release.

Detail

  • Links that respond with HTTP 401 (unauthorized) responses are now considered broken by default.
  • Timeouts that occur when checking a link are now reported with a distinct timeout status code, instead of the previous broken.
  • The previous behaviours are still available and can be configured on an opt-in basis per-project using conf.py.

Relates

@jayaddison

This comment was marked as resolved.

Sign in to view
@jayaddison jayaddison requested a review from AA-Turner July 20, 2024 17:12
@AA-Turner AA-Turner added this to the 8.0.0 milestone Jul 20, 2024
AA-Turner
AA-Turner reviewed Jul 20, 2024
View reviewed changes
CHANGES.rst Outdated Show resolved Hide resolved
@AA-Turner
Copy link
Member

I've added a draft of the changes to configuration.rst -- feel free to rewrite.

A

jayaddison
jayaddison commented Jul 20, 2024
View reviewed changes
CHANGES.rst Outdated Show resolved Hide resolved
@AA-Turner AA-Turner changed the title [linkcheck] Update configuration defaults for Sphinx v8.x linkcheck: Update configuration defaults for Sphinx 8 Jul 20, 2024
@AA-Turner AA-Turner changed the title linkcheck: Update configuration defaults for Sphinx 8 linkcheck: Update configuration defaults for Sphinx 8.0 Jul 20, 2024
@AA-Turner AA-Turner merged commit cc08854 into sphinx-doc:master Jul 20, 2024
21 checks passed
@AA-Turner
Copy link
Member

Thanks!

A

@jayaddison jayaddison deleted the sphinx-8.x/linkcheck-config-defaults branch July 20, 2024 21:18
@jayaddison
Copy link
Contributor Author

Thank you!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@AA-Turner AA-Turner AA-Turner approved these changes

Assignees
No one assigned
Labels
builder:linkcheck internals:config type:enhancement enhance or introduce a new feature
Projects
None yet
Milestone
8.0.0
Development

Successfully merging this pull request may close these issues.
2 participants
@jayaddison @AA-Turner