Skip to content

Commit

Permalink
Add Python Intersphinx syntax to style guide (wpilibsuite#2654)
Browse files Browse the repository at this point in the history
  • Loading branch information
sciencewhiz authored and GrahamSH-LLK committed Jun 12, 2024
1 parent 8edbabd commit 3ed5735
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions source/docs/contributing/frc-docs/style-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.sphinx-doc.org/en/master/usage/domains/python.html>`__ (example linking to the DriverStation API docs).

.. code-block:: ReST
:external:py:class:`Python <robotpy:wpilib.DriverStation>`
This expands to be equivalent to:

.. code-block:: ReST
`Python <https://robotpy.readthedocs.io/projects/robotpy/en/stable/wpilib/DriverStation.html#wpilib.DriverStation>`__
Images
------

Expand Down

0 comments on commit 3ed5735

Please sign in to comment.