Skip to content

Commit 37e573b

Browse files
jasondamingjasondaming
authored
Merge branch 'wpilibsuite:main' into moredevices
2 parents f85d29f + 02adc8a commit 37e573b

File tree

238 files changed

+28813
-13195
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+28813
-13195
lines changed

‎.github/workflows/CI.yml

+10-10
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ env:
77

88
jobs:
99
build-pdf:
10-
runs-on: ubuntu-latest
10+
runs-on: ubuntu-22.04
1111
steps:
1212
- uses: actions/checkout@v4
1313
- uses: actions/setup-python@v5
@@ -32,7 +32,7 @@ jobs:
3232
if-no-files-found: error
3333

3434
build-html:
35-
runs-on: ubuntu-latest
35+
runs-on: ubuntu-22.04
3636
steps:
3737
- uses: actions/checkout@v4
3838
- uses: actions/setup-python@v5
@@ -57,7 +57,7 @@ jobs:
5757
if-no-files-found: error
5858

5959
build-html-translation:
60-
runs-on: ubuntu-latest
60+
runs-on: ubuntu-22.04
6161
steps:
6262
- uses: actions/checkout@v4
6363
with:
@@ -87,7 +87,7 @@ jobs:
8787
# This job is sourced from https://github.com/aiven/devportal/blob/main/.github/workflows/linkcheck-changed-files.yaml
8888
# It is CC 4.0 I licensed: https://creativecommons.org/licenses/by/4.0/
8989
# Changes have been made.
90-
runs-on: ubuntu-latest
90+
runs-on: ubuntu-22.04
9191
steps:
9292
- uses: actions/checkout@v4
9393
with:
@@ -116,7 +116,7 @@ jobs:
116116
fi
117117
118118
check-linting:
119-
runs-on: ubuntu-latest
119+
runs-on: ubuntu-22.04
120120
steps:
121121
- uses: actions/checkout@v4
122122
- uses: actions/setup-python@v5
@@ -130,7 +130,7 @@ jobs:
130130
make lint
131131
132132
check-image-size:
133-
runs-on: ubuntu-latest
133+
runs-on: ubuntu-22.04
134134
steps:
135135
- uses: actions/checkout@v4
136136
- uses: actions/setup-python@v5
@@ -144,18 +144,18 @@ jobs:
144144
make sizecheck
145145
146146
check-spelling:
147-
runs-on: ubuntu-latest
147+
runs-on: ubuntu-22.04
148148
steps:
149149
- uses: actions/checkout@v4
150150
- name: misspell
151151
uses: reviewdog/action-misspell@v1
152152
with:
153153
locale: "US"
154154
reporter: "github-check"
155-
fail_on_error: "true"
155+
fail_level: "error"
156156

157157
check-redirects:
158-
runs-on: ubuntu-latest
158+
runs-on: ubuntu-22.04
159159
steps:
160160
- uses: actions/checkout@v4
161161
- name: Checkout main
@@ -175,7 +175,7 @@ jobs:
175175
[[ $(<source/redirects.txt) == $(git show origin/main:source/redirects.txt)* ]] || { echo "Error: redirects.txt can only be appended to. Lines cannot be modified or deleted."; exit 1; }
176176
177177
check-formatting:
178-
runs-on: ubuntu-latest
178+
runs-on: ubuntu-22.04
179179
steps:
180180
- uses: actions/checkout@v4
181181
- uses: actions/setup-python@v5

‎.github/workflows/base-branch.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88

99
jobs:
1010
check-base-branch:
11-
runs-on: ubuntu-latest
11+
runs-on: ubuntu-22.04
1212
steps:
1313
- name: Base Branch
1414
run: |

‎.github/workflows/inspector.json

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
{
44
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/allwpilib/",
55
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
6-
"latestVersion": "v2025.1.1-beta-1"
6+
"latestVersion": "v2025.1.1-beta-3"
77
},
88
{
99
"baseUrl": "https://github.com/wpilibsuite/allwpilib/raw/",
1010
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
11-
"latestVersion": "v2025.1.1-beta-1"
11+
"latestVersion": "v2025.1.1-beta-3"
1212
},
1313
{
1414
"baseUrl": "https://raw.githubusercontent.com/robotpy/examples/",
@@ -18,13 +18,13 @@
1818
{
1919
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/",
2020
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
21-
"latestVersion": "v2025.1.1-beta-1"
21+
"latestVersion": "v2025.1.1-beta-3"
2222
},
2323
{
2424
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/StandaloneAppSamples/",
2525
"versionScheme": "v\\d{4}\\.\\d\\.\\d(?:-(?:alpha|beta)-\\d)?|[0-9a-f]{40}",
2626
"latestVersion":"6a5b6352807a8759bd0f012e57695c47f7ef7324"
2727
}
2828
],
29-
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst", "source/docs/software/hardware-apis/misc/addressable-leds.rst"]
29+
"ignoredFiles": ["source/docs/software/commandbased/command-scheduler.rst", "source/docs/software/hardware-apis/pneumatics/pressure.rst", "source/docs/software/hardware-apis/pneumatics/solenoids.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/telemetry/writing-sendable-classes.rst", "source/docs/software/advanced-controls/trajectories/troubleshooting.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-following-trajectory.rst", "source/docs/software/pathplanning/trajectory-tutorial/entering-constants.rst", "source/docs/software/convenience-features/event-based.rst", "source/docs/software/dashboards/glass/field2d-widget.rst", "source/docs/software/dashboards/smartdashboard/choosing-an-autonomous-program-from-smartdashboard.rst"]
3030
}

‎.github/workflows/link-check.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ env:
1111
jobs:
1212
check-links:
1313
if: github.repository_owner == 'wpilibsuite'
14-
runs-on: ubuntu-latest
14+
runs-on: ubuntu-22.04
1515
steps:
1616
- uses: actions/checkout@v4
1717
- uses: actions/setup-python@v5

‎.github/workflows/publish_stable.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ on:
77

88
jobs:
99
publish:
10-
runs-on: ubuntu-latest
10+
runs-on: ubuntu-22.04
1111
if: ${{ github.repository_owner == 'wpilibsuite' }}
1212
steps:
1313
- uses: actions/checkout@v4

‎.github/workflows/update-rli-commands.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ on:
66
jobs:
77
check-rli:
88
if: contains(github.event.comment.html_url, '/pull/') && contains(github.event.comment.body, '\inspector')
9-
runs-on: ubuntu-latest
9+
runs-on: ubuntu-22.04
1010
steps:
1111
# ---- Find Trigger States ----
1212
# Run Inspector autofix on everything

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ SPHINXBUILD = sphinx-build
77
SOURCEDIR = source
88
BUILDDIR = build
99
LINTER = python3 scripts/doc8_redown.py
10-
LINTEROPTS = --ignore D001 # D001 is linelength
10+
LINTEROPTS = --ignore D001 --ignore-path "source/docs/software/wpilib-tools/robotbuilder/resources/**" # D001 is linelength
1111
SIZECHECKER = python3 -m scripts.imagesizechecker
1212
CONFEXCLUDE = --exclude-file source/conf.py
1313
SIZEMAX = 500

‎make.bat

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ set SOURCEDIR=source
1111
set BUILDDIR=build
1212
set SPHINXOPTS=-W --keep-going -q -T
1313
set LINTER=python scripts/doc8_redown.py
14-
set LINTEROPTS=--ignore D001 --ignore D004
14+
set LINTEROPTS=--ignore D001 --ignore D004 --ignore-path "source/docs/software/wpilib-tools/robotbuilder/resources/**"
1515
set SIZECHECKER=python -m scripts.imagesizechecker
1616
set CONFEXCLUDE=--exclude-file source/conf.py
1717
set SIZEMAX=500

‎poetry.lock

+31-13
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml

+3-2
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,15 @@ modern-sphinx-version-warning = "==1.1.6"
2727
sphinxcontrib-htmlhelp = "==2.1.0"
2828
sphinxcontrib-serializinghtml = "==2.0.0"
2929
sphinxcontrib-svg2pdfconverter = "==1.2.2"
30-
sphinxcontrib-video = "==0.2.1"
30+
sphinxcontrib-video = "==0.3.1"
31+
sphinx_contributors = "==0.2.7"
3132
sphinxext-delta = "==0.2.0"
3233
sphinxext-mimic = "==0.1.1"
3334
sphinxext-opengraph = "==0.9.0"
3435
sphinxext-photofinish = "==0.1.11"
3536
sphinxext-presentations = "==0.3.1"
3637
sphinxext-rediraffe = "==0.2.7"
37-
sphinxext-remoteliteralinclude = "==0.4.0"
38+
sphinxext-remoteliteralinclude = "==0.5.0"
3839
sphinxext-toptranslators = "==0.1.3"
3940
urllib3 = ">=1.26.6, <2.0.0"
4041
frccontrol = "==2023.28"

‎source/_extensions/wpilib_release.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ def run(self) -> List[nodes.Node]:
2424

2525
release_url = f"https://api.github.com/repos/wpilibsuite/allwpilib/releases/tags/{version}"
2626
release_json = requests.get(release_url)
27+
release_json.raise_for_status()
2728
release: Dict = release_json.json()
2829

2930
cf_folder = f"https://packages.wpilib.workers.dev/installer/{version}"
@@ -32,9 +33,9 @@ def run(self) -> List[nodes.Node]:
3233
)
3334

3435
def get_url_size(osname):
35-
soup = BeautifulSoup(
36-
requests.get(f"{cf_folder}/{osname}/").text, "html.parser"
37-
)
36+
release_data = requests.get(f"{cf_folder}/{osname}/")
37+
release_data.raise_for_status()
38+
soup = BeautifulSoup(release_data.text, "html.parser")
3839
file = str(soup.find_all("tr")[-1].contents[0].string)
3940
size = str(soup.find_all("tr")[-1].contents[2].string)
4041
url_part = f"/{osname}/{file}"

‎source/_static/css/frc-rtd.css

+1
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
.rst-content video {
4646
max-width: 100%;
4747
height: auto;
48+
cursor: pointer;
4849
}
4950

5051
.document img {

‎source/conf.py

+5-1
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@
5757
"sphinx-prompt",
5858
"sphinx_toolbox.collapse",
5959
"sphinx_copybutton",
60+
"sphinx_contributors",
6061
]
6162

6263
local_extensions = [
@@ -181,6 +182,8 @@
181182
# This pattern also affects html_static_path and html_extra_path.
182183
exclude_patterns = [
183184
"docs/yearly-overview/2020-Game-Data.rst",
185+
"docs/software/wpilib-tools/robotbuilder/resources/**",
186+
"docs/beta/*",
184187
]
185188

186189
# Specify the master doc file, AKA our homepage
@@ -193,6 +196,7 @@
193196
"docs/software/vision-processing/introduction/diagrams/vision-code-on-a-coprocessor.drawio.svg",
194197
"docs/controls-overviews/images/frc-control-system-layout.svg",
195198
"docs/controls-overviews/images/frc-control-system-layout-rev.svg",
199+
"docs/controls-overviews/images/frc-control-system-layout-basic.svg",
196200
]
197201

198202
# Required to display LaTeX in hover content
@@ -329,7 +333,7 @@ def new_send(self, data):
329333
)
330334

331335
new_data = data
332-
if b"api.github.com" in headers[b"host"]:
336+
if headers[b"host"].endswith(b"api.github.com"):
333337
if b"authorization" not in headers:
334338
if github_token := os.environ.get("GITHUB_TOKEN", None):
335339
new_data = (

‎source/docs/beta/tasks/beta-task-overview.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Task 1 - Install Software (Targeted Completion 10/28/2024)
1818

1919
The purpose of Task 1 is to complete installation of the new Control System software. This task consists of 1 Objective
2020

21-
1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, and any vendor libraries e.g. CTRE Phoenix, REVLib, etc)
21+
1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, and any vendor libraries using the :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` e.g. CTRE Phoenix, REVLib, etc)
2222

2323
Task 2 - Basic Benchtop Test (Targeted Completion 11/4/2024)
2424
------------------------------------------------------------
@@ -46,5 +46,5 @@ The purpose of Task 4 is to write new code in order to test features and functio
4646

4747
1. Java: Use :doc:`Epilogue annotation logging </docs/software/telemetry/robot-telemetry-with-annotations>`
4848
2. Java: Use the re-written :doc:`Java units library </docs/software/basic-programming/java-units>`
49-
3. Java/C++: Utilize the new Vendor Dependency manager in Visual Studio Code
49+
3. Java/C++: Utilize the new :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` in Visual Studio Code
5050

‎source/docs/beta/tasks/task-4-new-features.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The purpose of this task is to test any newly developed or heavily modified feat
2121

2222
**Java/C++**
2323

24-
- Utilize the new Vendor Dependency manager in Visual Studio Code
24+
- Utilize the new Vendor :doc:`Dependency Manager </docs/software/vscode-overview/3rd-party-libraries>` in Visual Studio Code
2525

2626
**Java/C++/Python**
2727

‎source/docs/contributing/frc-docs/build-instructions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ The redirect checker makes sure that there are valid redirects for all files. Th
9292

9393
Type the command ``.\make html`` to generate HTML content. The content is located in the ``build/html`` directory at the root of the repository.
9494

95-
## Building PDF
95+
### Building PDF
9696

9797
.. warning:: Please note that PDF build on Windows may result in distorted images for SVG content. This is due to a lack of librsvg2-bin support on Windows.
9898

9999
Type the command ``.\make latexpdf`` to generate PDF content. The PDF is located in the ``build/latex`` directory at the root of the repository.
100100

101-
## Building EPUB
101+
### Building EPUB
102102

103103
Type the command ``.\make epub`` to generate EPUB content. The EPUB is located in the ``build/epub`` directory at the root of the repository.
104104

‎source/docs/contributing/frc-docs/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,5 @@
88
build-instructions
99
drawio-saving-instructions
1010
translations
11+
top-contributors
1112
top-translators

0 commit comments

Comments
 (0)