Skip to content

Docs: configure linkcheck #9810

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

Merged
merged 2 commits into from
Dec 15, 2022
+5 −1
Merged

Docs: configure linkcheck #9810

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7cd049
Docs: configure linkcheck
humitos Dec 14, 2022
dec95a1
Docs: define `linkcheck_timeout` in the example
humitos Dec 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
release = version
exclude_patterns = ["_build", "shared"]
default_role = "obj"
intersphinx_timeout = 3 # 3 seconds timeout
intersphinx_mapping = {
"python": ("https://docs.python.org/3.10/", None),
"django": (
Expand Down Expand Up @@ -191,6 +192,9 @@
<p>Try using the search box or go to the homepage.</p>
""",
}
linkcheck_retries = 2
linkcheck_timeout = 1
linkcheck_workers = 10
linkcheck_ignore = [
r"http://127\.0\.0\.1",
r"http://localhost",
Expand Down
2 changes: 1 addition & 1 deletion docs/user/build-customization.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ This helps ensure that all external links are still valid and readers aren't lin
python: "3.10"
jobs:
pre_build:
- python -m sphinx -b linkcheck docs/ _build/linkcheck
- python -m sphinx -b linkcheck -D linkcheck_timeout=1 docs/ _build/linkcheck


Support Git LFS (Large File Storage)
Expand Down