Skip to content

Commit 78ab409

Browse files
authored
Update RLIs for 2024.1.1 (#2494)
Update ZTR to use more RLIs and fix some explanations
1 parent 3e78957 commit 78ab409

33 files changed

+331
-313
lines changed

.github/workflows/inspector.json

Lines changed: 3 additions & 3 deletions
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": "v2024.1.1-beta-4"
6+
"latestVersion": "v2024.1.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": "v2024.1.1-beta-4"
11+
"latestVersion": "v2024.1.1"
1212
},
1313
{
1414
"baseUrl": "https://raw.githubusercontent.com/robotpy/examples/",
@@ -26,5 +26,5 @@
2626
"latestVersion":"3b64aadee717c9f0566497a40fd0be7d0eaed96d"
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-gradlerio/code-formatting.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-gradlerio/code-formatting.rst", "source/docs/software/advanced-controls/state-space/state-space-pose-estimators.rst", "source/docs/software/commandbased/pid-subsystems-commands.rst", "source/docs/software/commandbased/profilepid-subsystems-commands.rst", "source/docs/software/commandbased/subsystems.rst", "source/docs/software/hardware-apis/motors/wpi-drive-classes.rst", "source/docs/software/pathplanning/trajectory-tutorial/creating-drive-subsystem.rst", "source/docs/software/telemetry/writing-sendable-classes.rst"]
3030
}

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,13 @@ When possible, instead of using code blocks, an RLI should be used. This pulls
107107

108108
.. code-block:: ReST
109109
110-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecontroller/Robot.java
110+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecontroller/Robot.java
111111
:language: java
112112
:lines: 44-61
113113
:linenos:
114114
:lineno-start: 44
115115
116-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/RamseteController/cpp/Robot.cpp
116+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/RamseteController/cpp/Robot.cpp
117117
:language: c++
118118
:lines: 18-30
119119
:linenos:
@@ -129,7 +129,7 @@ To create code tabs in an article, you can use the ``.. tab-set-code::`` directi
129129
130130
.. tab-set-code::
131131
132-
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecontroller/Robot.java
132+
.. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecontroller/Robot.java
133133
:language: java
134134
:lines: 44-61
135135
:linenos:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,13 @@ A more complete example of ``ProfiledPIDController`` usage is provided in the El
114114

115115
.. tab-set-code::
116116

117-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
117+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatorprofiledpid/Robot.java
118118
:language: java
119119
:lines: 5-
120120
:linenos:
121121
:lineno-start: 5
122122

123-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
123+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/ElevatorProfiledPID/cpp/Robot.cpp
124124
:language: c++
125125
:lines: 5-
126126
:linenos:

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,13 +136,13 @@ A more complete example of ``TrapezoidProfile`` usage is provided in the Elevato
136136

137137
.. tab-set-code::
138138

139-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
139+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/elevatortrapezoidprofile/Robot.java
140140
:language: java
141141
:lines: 5-
142142
:linenos:
143143
:lineno-start: 5
144144

145-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
145+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/ElevatorTrapezoidProfile/cpp/Robot.cpp
146146
:language: c++
147147
:lines: 5-
148148
:linenos:

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

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -69,23 +69,23 @@ The ``LinearSystem`` class contains methods for easily creating state-space syst
6969
.. tab-item:: Java
7070
:sync: java
7171

72-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
72+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheelsysid/Robot.java
7373
:language: java
74-
:lines: 33-47
74+
:lines: 32-46
7575
:linenos:
7676
:lineno-start: 33
7777

7878

7979
.. tab-item:: C++
8080
:sync: c++
8181

82-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
82+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
8383
:language: c++
8484
:lines: 17
8585
:linenos:
8686
:lineno-start: 17
8787

88-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
88+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
8989
:language: c++
9090
:lines: 30-46
9191
:linenos:
@@ -108,22 +108,22 @@ The ``LinearSystem`` class contains methods to easily create a model of a flywhe
108108
.. tab-item:: Java
109109
:sync: java
110110

111-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
111+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
112112
:language: java
113-
:lines: 34-47
113+
:lines: 33-46
114114
:linenos:
115-
:lineno-start: 34
115+
:lineno-start: 33
116116

117117
.. tab-item:: C++
118118
:sync: c++
119119

120-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
120+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
121121
:language: c++
122122
:lines: 17-17
123123
:linenos:
124124
:lineno-start: 17
125125

126-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
126+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
127127
:language: c++
128128
:lines: 17,31-46
129129
:linenos:
@@ -148,22 +148,22 @@ Because the feedback controller computes error using the :term:`x-hat` estimated
148148
.. tab-item:: Java
149149
:sync: java
150150

151-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
151+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
152152
:language: java
153-
:lines: 49-59
153+
:lines: 48-58
154154
:linenos:
155-
:lineno-start: 59
155+
:lineno-start: 48
156156

157157
.. tab-item:: C++
158158
:sync: c++
159159

160-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
160+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
161161
:language: c++
162162
:lines: 13-13
163163
:linenos:
164164
:lineno-start: 13
165165

166-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
166+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
167167
:language: c++
168168
:lines: 48-53
169169
:linenos:
@@ -185,22 +185,22 @@ Much like ``SimpleMotorFeedforward`` can be used to generate feedforward voltage
185185
.. tab-item:: Java
186186
:sync: java
187187

188-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
188+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
189189
:language: java
190-
:lines: 60-71
190+
:lines: 59-70
191191
:linenos:
192-
:lineno-start: 60
192+
:lineno-start: 59
193193

194194
.. tab-item:: C++
195195
:sync: c++
196196

197-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
197+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
198198
:language: c++
199199
:lines: 11
200200
:linenos:
201201
:lineno-start: 11
202202

203-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
203+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
204204
:language: c++
205205
:lines: 55-75
206206
:linenos:
@@ -216,22 +216,22 @@ LinearSystemLoop combines our system, controller, and observer that we created e
216216
.. tab-item:: Java
217217
:sync: java
218218

219-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
219+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
220220
:language: java
221-
:lines: 73-75
221+
:lines: 72-74
222222
:linenos:
223-
:lineno-start: 73
223+
:lineno-start: 72
224224

225225
.. tab-item:: C++
226226
:sync: c++
227227

228-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
228+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
229229
:language: c++
230230
:lines: 15-15
231231
:linenos:
232232
:lineno-start: 15
233233

234-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
234+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
235235
:language: c++
236236
:lines: 71-74
237237
:linenos:
@@ -244,22 +244,22 @@ Once we have our ``LinearSystemLoop``, the only thing left to do is actually run
244244
.. tab-item:: Java
245245
:sync: java
246246

247-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
247+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
248248
:language: java
249-
:lines: 96-121
249+
:lines: 95-120
250250
:linenos:
251-
:lineno-start: 96
251+
:lineno-start: 95
252252

253253
.. tab-item:: C++
254254
:sync: c++
255255

256-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
256+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheelSysId/cpp/Robot.cpp
257257
:language: c++
258258
:lines: 5-17
259259
:linenos:
260260
:lineno-start: 5
261261

262-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
262+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
263263
:language: c++
264264
:lines: 92-114
265265
:linenos:

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,21 +99,21 @@ WPILib's Kalman Filter classes' constructors take a linear system, a vector of p
9999
.. tab-set::
100100
.. tab-item:: Java
101101

102-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
102+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/statespaceflywheel/Robot.java
103103
:language: java
104-
:lines: 49-58
104+
:lines: 48-57
105105
:linenos:
106-
:lineno-start: 49
106+
:lineno-start: 48
107107

108108
.. tab-item:: C++
109109

110-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
110+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
111111
:language: c++
112112
:lines: 5-18
113113
:linenos:
114114
:lineno-start: 5
115115

116-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
116+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/StateSpaceFlywheel/cpp/Robot.cpp
117117
:language: c++
118118
:lines: 48-53
119119
:linenos:

source/docs/software/advanced-controls/trajectories/troubleshooting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,13 +109,13 @@ If your feedforwards are bad then the P controllers for each side of the robot w
109109

110110
.. tab-set-code::
111111

112-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecommand/RobotContainer.java
112+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/ramsetecommand/RobotContainer.java
113113
:language: java
114114
:lines: 123-124
115115
:linenos:
116116
:lineno-start: 123
117117

118-
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/RamseteCommand/cpp/RobotContainer.cpp
118+
.. remoteliteralinclude:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1/wpilibcExamples/src/main/cpp/examples/RamseteCommand/cpp/RobotContainer.cpp
119119
:language: c++
120120
:lines: 79-80
121121
:linenos:

0 commit comments

Comments
 (0)