Skip to content

Commit 2403dd5

Browse files
authored
Update RLIs for WPILib 2025.3.1 (#2981)
1 parent 8cbd8c0 commit 2403dd5

29 files changed

+167
-167
lines changed

.github/workflows/inspector.json

+3-3
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.2.1"
6+
"latestVersion": "v2025.3.1"
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.2.1"
11+
"latestVersion": "v2025.3.1"
1212
},
1313
{
1414
"baseUrl": "https://raw.githubusercontent.com/robotpy/examples/",
@@ -18,7 +18,7 @@
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"
21+
"latestVersion": "v2025.3.1"
2222
},
2323
{
2424
"baseUrl": "https://raw.githubusercontent.com/wpilibsuite/StandaloneAppSamples/",

source/docs/contributing/frc-docs/style-guide.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@ Follow the [WPILib style guide](https://github.com/wpilibsuite/styleguide/) for
101101
When possible, instead of using code blocks, an RLI should be used. This pulls code lines directly from GitHub, most commonly using the example programs. This automatically keeps the code up to date with any changes that are made. The format of an RLI is:
102102

103103
```ReST
104-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
104+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
105105
:language: java
106106
:lines: 19-25
107107
:lineno-match:
108108
109-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/GettingStarted/cpp/Robot.cpp
109+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/GettingStarted/cpp/Robot.cpp
110110
:language: c++
111111
:lines: 50-60
112112
:lineno-match:
@@ -126,7 +126,7 @@ To create code tabs in an article, you can use the ``.. tab-set-code::`` directi
126126

127127
````ReST
128128
.. tab-set-code::
129-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
129+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/gettingstarted/Robot.java
130130
:language: java
131131
:lines: 19-25
132132
:lineno-match:

source/docs/romi-robot/programming-romi.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ One aspect where a Romi project differs from a regular FRC robot project is that
3434

3535
To run a Romi program, first, ensure that your Romi is powered on. Next, connect to the ``WPILibPi-<number>`` WiFi network broadcast by the Romi. If you changed the Romi network settings (for example, to connect it to your own WiFi network) you may change the IP address that your program uses to connect to the Romi. To do this, open the ``build.gradle`` file and update the ``wpi.sim.envVar`` line to the appropriate IP address.
3636

37-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.1.1/vscode-wpilib/resources/gradle/javaromi/build.gradle
37+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.3.1/vscode-wpilib/resources/gradle/javaromi/build.gradle
3838
:language: groovy
3939
:lines: 44-47
4040
:lineno-match:

source/docs/software/advanced-controls/controllers/profiled-pidcontroller.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@ A more complete example of ``ProfiledPIDController`` usage is provided in the El
143143

144144
.. tab-set-code::
145145

146-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
146+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
147147
:language: java
148148
:lines: 5-
149149
:lineno-match:
150150

151-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
151+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
152152
:language: c++
153153
:lines: 5-
154154
:lineno-match:

source/docs/software/advanced-controls/controllers/trapezoidal-profiles.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -162,12 +162,12 @@ A more complete example of ``TrapezoidProfile`` usage is provided in the Elevato
162162

163163
.. tab-set-code::
164164

165-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
165+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
166166
:language: java
167167
:lines: 5-
168168
:lineno-match:
169169

170-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
170+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
171171
:language: c++
172172
:lines: 5-
173173
:lineno-match:

source/docs/software/advanced-controls/state-space/state-space-flywheel-walkthrough.rst

+18-18
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The ``LinearSystem`` class contains methods for easily creating state-space syst
6565
.. tab-item:: Java
6666
:sync: java
6767

68-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
68+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
6969
:language: java
7070
:lines: 32-46
7171
:lineno-match:
@@ -74,12 +74,12 @@ The ``LinearSystem`` class contains methods for easily creating state-space syst
7474
.. tab-item:: C++
7575
:sync: c++
7676

77-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
77+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
7878
:language: c++
7979
:lines: 17
8080
:lineno-match:
8181

82-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
82+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
8383
:language: c++
8484
:lines: 30-46
8585
:lineno-match:
@@ -112,20 +112,20 @@ The ``LinearSystem`` class contains methods to easily create a model of a flywhe
112112
.. tab-item:: Java
113113
:sync: java
114114

115-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
115+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
116116
:language: java
117117
:lines: 33-46
118118
:lineno-match:
119119

120120
.. tab-item:: C++
121121
:sync: c++
122122

123-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
123+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
124124
:language: c++
125125
:lines: 17-17
126126
:lineno-match:
127127

128-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
128+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
129129
:language: c++
130130
:lines: 31-46
131131
:lineno-match:
@@ -161,20 +161,20 @@ Because the feedback controller computes error using the :term:`x-hat` estimated
161161
.. tab-item:: Java
162162
:sync: java
163163

164-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
164+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
165165
:language: java
166166
:lines: 48-58
167167
:lineno-match:
168168

169169
.. tab-item:: C++
170170
:sync: c++
171171

172-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
172+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
173173
:language: c++
174174
:lines: 13-13
175175
:lineno-match:
176176

177-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
177+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
178178
:language: c++
179179
:lines: 48-53
180180
:lineno-match:
@@ -202,20 +202,20 @@ Much like ``SimpleMotorFeedforward`` can be used to generate feedforward voltage
202202
.. tab-item:: Java
203203
:sync: java
204204

205-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
205+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
206206
:language: java
207207
:lines: 59-70
208208
:lineno-match:
209209

210210
.. tab-item:: C++
211211
:sync: c++
212212

213-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
213+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
214214
:language: c++
215215
:lines: 11
216216
:lineno-match:
217217

218-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
218+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
219219
:language: c++
220220
:lines: 55-75
221221
:lineno-match:
@@ -237,20 +237,20 @@ LinearSystemLoop combines our system, controller, and observer that we created e
237237
.. tab-item:: Java
238238
:sync: java
239239

240-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
240+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
241241
:language: java
242242
:lines: 72-74
243243
:lineno-match:
244244

245245
.. tab-item:: C++
246246
:sync: c++
247247

248-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
248+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
249249
:language: c++
250250
:lines: 15-15
251251
:lineno-match:
252252

253-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
253+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
254254
:language: c++
255255
:lines: 71-74
256256
:lineno-match:
@@ -270,20 +270,20 @@ Once we have our ``LinearSystemLoop``, the only thing left to do is actually run
270270
.. tab-item:: Java
271271
:sync: java
272272

273-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
273+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
274274
:language: java
275275
:lines: 94-119
276276
:lineno-match:
277277

278278
.. tab-item:: C++
279279
:sync: c++
280280

281-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
281+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
282282
:language: c++
283283
:lines: 5-17
284284
:lineno-match:
285285

286-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
286+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
287287
:language: c++
288288
:lines: 92-114
289289
:lineno-match:

source/docs/software/advanced-controls/state-space/state-space-observers.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -91,19 +91,19 @@ WPILib's Kalman Filter classes' constructors take a linear system, a vector of p
9191
.. tab-set::
9292
.. tab-item:: Java
9393

94-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
94+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
9595
:language: java
9696
:lines: 48-57
9797
:lineno-match:
9898

9999
.. tab-item:: C++
100100

101-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
101+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
102102
:language: c++
103103
:lines: 5-18
104104
:lineno-match:
105105

106-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
106+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
107107
:language: c++
108108
:lines: 48-53
109109
:lineno-match:

source/docs/software/advanced-gradlerio/code-formatting.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,6 @@ modifiableFileExclude {
196196

197197
You can turn this into a :doc:`CI check <robot-code-ci>` by running ``git --no-pager diff --exit-code HEAD``, as shown in the example GitHub Actions workflow below:
198198

199-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.2.1/.github/workflows/lint-format.yml
199+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.1/.github/workflows/lint-format.yml
200200
:language: yaml
201201
:lines: 1-5, 13, 21-43

source/docs/software/advanced-gradlerio/profiling-with-visualvm.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To begin, [download VisualVM](https://visualvm.github.io/download.html) and unpa
1010

1111
GradleRIO supports passing JVM launch arguments, and this is what is necessary to enable remote debugging. Remote debugging is a feature that allows a local machine (such as the user's desktop) to view important information about a remote target (in our case, a roboRIO). To begin, locate the ``frcJava`` code block located in the projects ``build.gradle``. Below is what is looks like.
1212

13-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.1.1/vscode-wpilib/resources/gradle/java/build.gradle
13+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.3.1/vscode-wpilib/resources/gradle/java/build.gradle
1414
:language: groovy
1515
:lines: 15-42
1616
:lineno-match:

source/docs/software/basic-programming/java-gc.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ All objects in Java are retained in a section of memory called the *heap*. As ob
3333

3434
Since ``OutOfMemoryError``\ s both crash the program and are a common reason to want a heap dump, the JVM can be configured to automatically take a heap dump the moment an ``OutOfMemoryError`` is caught by the JVM. To configure these options, locate the ``frcJava`` code block in your project's ``build.gradle``:
3535

36-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.1.1/vscode-wpilib/resources/gradle/java/build.gradle
36+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/vscode-wpilib/v2025.3.1/vscode-wpilib/resources/gradle/java/build.gradle
3737
:language: groovy
3838
:lines: 15-42
3939
:lineno-match:

0 commit comments

Comments
 (0)