From 901e6ab5b031493ce79c6a9f23da9bb8644f9e10 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Fri, 23 Apr 2021 10:02:24 -0400 Subject: [PATCH] Referencing_documentation_other_libraries --- docs/design_guide.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 1bac4df61b..5bd6bbd387 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -383,6 +383,14 @@ Renders as: :param float degrees: Degrees to turn right +Documentation References to other Libraries +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +When you need to make references to documentation in other libraries you should refer the class using single +backticks ``:class:`~adafruit_motor.servo.Servo```. You must add also the reference in the ``conf.py`` file in the +``intersphinx_mapping section`` adding a new entry:: + + "adafruit_motor": ("https://circuitpython.readthedocs.io/projects/motor/en/latest/", None,), + Use BusDevice --------------------------------------------------------------------------------