Skip to content

Commit 901e6ab

Browse files
committed
Referencing_documentation_other_libraries
1 parent 346740e commit 901e6ab

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/design_guide.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -383,6 +383,14 @@ Renders as:
383383

384384
:param float degrees: Degrees to turn right
385385

386+
Documentation References to other Libraries
387+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
388+
When you need to make references to documentation in other libraries you should refer the class using single
389+
backticks ``:class:`~adafruit_motor.servo.Servo```. You must add also the reference in the ``conf.py`` file in the
390+
``intersphinx_mapping section`` adding a new entry::
391+
392+
"adafruit_motor": ("https://circuitpython.readthedocs.io/projects/motor/en/latest/", None,),
393+
386394
Use BusDevice
387395
--------------------------------------------------------------------------------
388396

0 commit comments

Comments
 (0)