Skip to content

Commit 6db1583

Browse files
authored
RobotPy API updates (#2500)
* Switch RobotPy links from latest to stable * Update API doc to use :py:class: * Add python API doc stub
1 parent be6acce commit 6db1583

File tree

4 files changed

+5
-4
lines changed

4 files changed

+5
-4
lines changed

source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ def new_send(self, data):
329329
http.client.HTTPConnection.send = new_send
330330

331331
intersphinx_mapping = {
332-
"robotpy": ("https://robotpy.readthedocs.io/projects/robotpy/en/latest/", None),
332+
"robotpy": ("https://robotpy.readthedocs.io/projects/robotpy/en/stable/", None),
333333
}
334334

335335
# We recommend adding the following config value.

source/docs/software/basic-programming/alliancecolor.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Get Alliance Color
22
==================
33

4-
The ``DriverStation`` class (`Java <https://github.wpilib.org/allwpilib/docs/release/java/edu/wpi/first/wpilibj/DriverStation.html>`__, `C++ <https://github.wpilib.org/allwpilib/docs/release/cpp/classfrc_1_1_driver_station.html>`__, `Python <https://robotpy.readthedocs.io/projects/wpilib/en/stable/wpilib/DriverStation.html>`__) has many useful features for getting data from the Driver Station computer. One of the most important features is ``getAlliance`` (Java & Python) / ``GetAlliance`` (C++).
4+
The ``DriverStation`` class (`Java <https://github.wpilib.org/allwpilib/docs/release/java/edu/wpi/first/wpilibj/DriverStation.html>`__, `C++ <https://github.wpilib.org/allwpilib/docs/release/cpp/classfrc_1_1_driver_station.html>`__, :py:class:`Python <robotpy:wpilib.DriverStation>`) has many useful features for getting data from the Driver Station computer. One of the most important features is ``getAlliance`` (Java & Python) / ``GetAlliance`` (C++).
55

66
Getting your Alliance Color and Doing an Action
77
-----------------------------------------------

source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Community translations can be found in a variety of languages in the bottom-left
238238

239239
C++
240240

241-
.. button-link:: https://robotpy.readthedocs.io/projects/robotpy/en/latest/
241+
.. button-link:: https://robotpy.readthedocs.io/projects/robotpy/en/stable/
242242
:color: primary
243243
:shadow:
244244
:align: center
@@ -371,7 +371,7 @@ Community translations can be found in a variety of languages in the bottom-left
371371

372372
WPILib Java API Docs <https://github.wpilib.org/allwpilib/docs/release/java/index.html>
373373
WPILib C++ API Docs <https://github.wpilib.org/allwpilib/docs/release/cpp/index.html>
374-
WPILib Python API Docs <https://robotpy.readthedocs.io/projects/robotpy/en/latest/>
374+
WPILib Python API Docs <https://robotpy.readthedocs.io/projects/robotpy/en/stable/>
375375

376376
.. toctree::
377377
:maxdepth: 1

source/stubs/api-docs-stub.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Java and CSS class documentation.
1111

1212
WPILib Java API Docs <https://github.wpilib.org/allwpilib/docs/release/java/index.html>
1313
WPILib C++ API Docs <https://github.wpilib.org/allwpilib/docs/release/cpp/index.html>
14+
WPILib Python API Docs <https://robotpy.readthedocs.io/projects/robotpy/en/stable/api.html>

0 commit comments

Comments
 (0)