Skip to content

MAINT - Fix linkcheck failures #2207

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 9 commits into from
May 15, 2025
Merged

MAINT - Fix linkcheck failures #2207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
29cc5cc
:wrench: Update linkcheck rules
May 12, 2025
52ff248
Fix broken links
May 12, 2025
756aef6
Merge branch 'main' into trallard/patch-link-check-CI
trallard May 12, 2025
e96308b
Update regex for gnu gettext
May 12, 2025
64a5b1b
Remove anchors checks to speed up checks
May 12, 2025
742f1ff
Apply suggestions from code review
trallard May 13, 2025
6306245
Update docs/conf.py
trallard May 13, 2025
a5e5795
[pre-commit.ci] Automatic linting and formatting fixes
pre-commit-ci[bot] May 13, 2025
7501c29
Update linkcheck config - reduce timeout limit
May 14, 2025
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
2 changes: 1 addition & 1 deletion docs/community/design-system.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ color and typography in the PyData Sphinx theme:
including font stacks, sizes, and weights in the
[`fonts.scss` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/assets/styles/variables/_fonts.scss).
2. You can find all the PyData Sphinx theme colors in the
[`color.scss` file](https://github.com/pydata/pydata-sphinx-theme/blob/main/src/pydata_sphinx_theme/assets/styles/variables/_color.scss)
[`color.scss` file](https://github.com/pydata/pydata-sphinx-theme/tree/main/src/pydata_sphinx_theme/assets/styles/variables/_color.scss)
2. **Figma Design File:** The Figma file contains the visual design and specifications
for the typography styles, including font sizes, line heights,
and spacing used throughout the theme. It also includes our color palette and its use cases, as well as details on interactive components and their states.
Expand Down
2 changes: 1 addition & 1 deletion docs/community/inspiration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ When making new decisions about design and UI/UX, we often consult these themes
link: https://docs.docker.com/
image: ../_static/inspiration/docker-mark-blue.svg
- title: "**PyTorch**"
link: https://pytorch.org/docs/stable/index.html
link: https://docs.pytorch.org/docs/stable/index.html
image: https://docs.pytorch.org/docs/stable/_static/images/logo-dark.svg
- title: "**Docasaurus**"
link: https://docusaurus.io/docs
Expand Down
2 changes: 1 addition & 1 deletion docs/community/topics/assets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,5 +52,5 @@ Our Webpack build generates a collection of [Jinja macros](https://jinja.pallets

These macros are imported in the main `layout.html` file, and then inserted at various places on the page to link the static assets.

Some assets [are "preloaded"](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/preload), meaning that the browser begins requesting these resources before they're needed.
Some assets [are "preloaded"](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/preload), meaning that the browser begins requesting these resources before they're needed.
In particular, our JavaScript assets are preloaded in `<head>`, and the scripts are loaded at the end of `<body>`.
9 changes: 6 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,6 +377,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
# get a 403 on CI
"https://canvas.workday.com/styles/tokens/type",
"https://unsplash.com/",
r"https://www.gnu.org/software/gettext/.*",
]

linkcheck_allowed_redirects = {
Expand All @@ -389,7 +390,7 @@ def setup(app: Sphinx) -> Dict[str, Any]:
r"https://virtualenv.pypa.io/": "https://virtualenv.pypa.io/en/latest/",
# catching redirects in rtd
r"https://[A-Za-z\d_\-\.]+.readthedocs.io/": r"https://[A-Za-z\d_\-\.]+\.readthedocs\.io(/en)?/(stable|latest)/",
r"https://readthedocs.org/": r"https://about.readthedocs.com\?ref=readthedocs.org",
r"https://readthedocs.org/": r"https://about.readthedocs.com/\?ref=app.readthedocs.org",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we change the link to readthedocs.org to https://about.readthedocs.com?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the canonical URL is/should be readthedocs.com, I do not think we need to change it.

r"https://app.readthedocs.org/dashboard/": r"https://app.readthedocs.org/accounts/login/\?next=/dashboard/",
# miscellanenous urls
r"https://python.arviz.org/": "https://python.arviz.org/en/stable/",
Expand All @@ -398,8 +399,10 @@ def setup(app: Sphinx) -> Dict[str, Any]:
r"https://gitlab.com": "https://about.gitlab.com/",
r"http://www.yahoo.com": "https://www.yahoo.com/",
r"https://feature-engine.readthedocs.io/": "https://feature-engine.trainindata.com/en/latest/",
r"https://picsum.photos/": r"https://fastly.picsum.photos/",
}

# we have had issues with linkcheck timing and retries on www.gnu.org
linkcheck_retries = 3
linkcheck_timeout = 50
linkcheck_retries = 1
linkcheck_timeout = 5
linkcheck_report_timeouts_as_broken = True
2 changes: 1 addition & 1 deletion docs/user_guide/fonts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The default body and header fonts can be changed as follows:
{% endblock %}

Your text may quickly show up as "unstyled" before the fonts are loaded. To reduce this, you may wish to explore options for
`preloading content <https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel/preload>`__,
`preloading content <https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/rel/preload>`__,
specifically the binary font files. This ensures the files will be loaded
before the CSS is parsed, but should be used with care.

Expand Down
Loading