From 901e6ab5b031493ce79c6a9f23da9bb8644f9e10 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Fri, 23 Apr 2021 10:02:24 -0400 Subject: [PATCH 1/5] 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 -------------------------------------------------------------------------------- From 2d80f6b872008a5afc07bffbeaf7a1e0522287aa Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 27 Apr 2021 17:11:42 -0400 Subject: [PATCH 2/5] Module_description_changes --- docs/design_guide.rst | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 5bd6bbd387..edd8c0a6f2 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -238,11 +238,34 @@ Module description After the license comment:: """ - `` - + `` ================================================= + + + * Author(s): + + Implementation Notes + -------------------- + + + **Hardware:** + + * Adafruit `Device Description + `_ (Product ID: ) + + **Software and Dependencies:** + + * Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + * Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + * Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + """ + Class description ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 4d0e183ae11e291390f54d3d8ed749976866b7d0 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 27 Apr 2021 17:18:14 -0400 Subject: [PATCH 3/5] Module_description_changes --- docs/design_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index edd8c0a6f2..5ba5788573 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -241,7 +241,7 @@ After the license comment:: `` ================================================= - + * Author(s): From a512dd230df419c204b7acd49c0cc7f9ebdce290 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 27 Apr 2021 17:34:45 -0400 Subject: [PATCH 4/5] word_order_better_phrasing --- docs/design_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index 5ba5788573..e9a275dd41 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -409,7 +409,7 @@ Renders as: 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 +backticks ``:class:`~adafruit_motor.servo.Servo```. You must also add 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,), From cb42acea53d4780a018db3bea253708d5d7dd404 Mon Sep 17 00:00:00 2001 From: jposada202020 Date: Tue, 27 Apr 2021 17:43:25 -0400 Subject: [PATCH 5/5] better_phrasing --- docs/design_guide.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design_guide.rst b/docs/design_guide.rst index e9a275dd41..8ad0428afa 100644 --- a/docs/design_guide.rst +++ b/docs/design_guide.rst @@ -410,7 +410,7 @@ 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 also add the reference in the ``conf.py`` file in the -``intersphinx_mapping section`` adding a new entry:: +``intersphinx_mapping section`` by adding a new entry:: "adafruit_motor": ("https://circuitpython.readthedocs.io/projects/motor/en/latest/", None,),