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

Fix rate limiting in sphinx link checker #1579

Merged
merged 9 commits into from
Nov 17, 2024
+12 −2
Merged

Fix rate limiting in sphinx link checker #1579

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
16e247b
include fix from wpilib/frc-docs
crschardt Nov 17, 2024
a89d96c
ignore 10.x.x.x URLs
crschardt Nov 17, 2024
9435763
make sure the github token is in the environment
crschardt Nov 17, 2024
fe7e5d4
is there a token?
crschardt Nov 17, 2024
c8aa3d6
silly mistake
crschardt Nov 17, 2024
9a4bc97
which one is working?
crschardt Nov 17, 2024
25ca685
formatted and cleaned up
crschardt Nov 17, 2024
01674b2
confirm that this is really making a difference
crschardt Nov 17, 2024
0491561
It does work
crschardt Nov 17, 2024
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
3 changes: 3 additions & 0 deletions .github/workflows/photonvision-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ on:
- 'docs/**'
- '.github/**'

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
build:
runs-on: ubuntu-22.04
Expand Down
11 changes: 9 additions & 2 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
import os

# import sys
# sys.path.insert(0, os.path.abspath('.'))

Expand Down Expand Up @@ -138,9 +139,15 @@ def setup(app):

sphinx_tabs_valid_builders = ["epub", "linkcheck"]

# -- Options for linkcheck -------------------------------------------------

# Excluded links for linkcheck
# These should be periodically checked by hand to ensure that they are still functional
linkcheck_ignore = ["https://www.raspberrypi.com/software/"]
linkcheck_ignore = [R"https://www.raspberrypi.com/software/", R"http://10\..+"]

token = os.environ.get("GITHUB_TOKEN", None)
if token:
linkcheck_auth = [(R"https://github.com/.+", token)]

# MyST configuration (https://myst-parser.readthedocs.io/en/latest/configuration.html)
myst_enable_extensions = ["colon_fence"]
Loading