From c316ac7f73421e9ccc53e4ae5dd94340c9e137b3 Mon Sep 17 00:00:00 2001 From: sciencewhiz Date: Sat, 1 Jun 2024 17:23:52 -0700 Subject: [PATCH] Add Python Intersphinx syntax to style guide (#2654) --- source/docs/contributing/frc-docs/style-guide.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/source/docs/contributing/frc-docs/style-guide.rst b/source/docs/contributing/frc-docs/style-guide.rst index f3e8a187f1..dd062cd2c8 100644 --- a/source/docs/contributing/frc-docs/style-guide.rst +++ b/source/docs/contributing/frc-docs/style-guide.rst @@ -217,6 +217,21 @@ However, in some cases where the same link must be referenced multiple times, th .. _this is a link: https://example.com +Python API Links +^^^^^^^^^^^^^^^^ + +Links to the RobotPY API documentation should use the following sphinx `python syntax `__ (example linking to the DriverStation API docs). + +.. code-block:: ReST + + :external:py:class:`Python ` + +This expands to be equivalent to: + +.. code-block:: ReST + + `Python `__ + Images ------