Skip to content

Commit cb3932c

Browse files
tekktriktekktrik
committed
Make other documentation links prettier
1 parent 8281008 commit cb3932c

7 files changed

Lines changed: 23 additions & 26 deletions

File tree

‎shared-bindings/analogio/__init__.c‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,11 @@
5959
//| :py:meth:`~analogio.AnalogIn.deinit` the hardware. The last step is optional
6060
//| because CircuitPython will do it automatically after the program finishes.
6161
//|
62-
//| For the essentials of `analogio`, see the CircuitPython Essentials
63-
//| Learn guide:
64-
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-analog-in
62+
//| For the essentials of `analogio`, see the `CircuitPython Essentials
63+
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-analog-in>`_
6564
//|
66-
//| For more information on using `analogio`, see this additional Learn guide:
67-
//| https://learn.adafruit.com/circuitpython-basics-analog-inputs-and-outputs
65+
//| For more information on using `analogio`, see `this additional Learn guide
66+
//| <https://learn.adafruit.com/circuitpython-basics-analog-inputs-and-outputs>`_
6867
//| """
6968
//|
7069

‎shared-bindings/board/__init__.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@
4747
//| the default pins and settings. For more information about serial communcication
4848
//| in CircuitPython, see the :mod:`busio`.
4949
//|
50-
//| For more information regarding the typical usage of :py:mod:`board`, refer to the CircuitPython
51-
//| Essentials Learn guide:
52-
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules
50+
//| For more information regarding the typical usage of :py:mod:`board`, refer to the `CircuitPython
51+
//| Essentials Learn guide
52+
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules>`_
5353
//|
5454
//| .. warning:: The board module varies by board. The APIs documented here may or may not be
5555
//| available on a specific board."""

‎shared-bindings/digitalio/__init__.c‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,11 @@
7373
//| led.value = False
7474
//| time.sleep(0.1)
7575
//|
76-
//| For the essentials of `digitalio`, see the CircuitPython Essentials
77-
//| Learn guide:
78-
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-digital-in-out
76+
//| For the essentials of `digitalio`, see the `CircuitPython Essentials
77+
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-digital-in-out>`_
7978
//|
80-
//| For more information on using `digitalio`, see this additional Learn guide:
81-
//| https://learn.adafruit.com/circuitpython-digital-inputs-and-outputs
79+
//| For more information on using `digitalio`, see `this additional Learn guide
80+
//| <https://learn.adafruit.com/circuitpython-digital-inputs-and-outputs>`_
8281
//| """
8382

8483
STATIC const mp_rom_map_elem_t digitalio_module_globals_table[] = {

‎shared-bindings/displayio/__init__.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@
5151
//| The `displayio` module contains classes to manage display output
5252
//| including synchronizing with refresh rates and partial updating.
5353
//|
54-
//| For more a more thorugh explanation and guide for using `displayio`, please
55-
//| refer to this Learn guide:
56-
//| https://learn.adafruit.com/circuitpython-display-support-using-displayio
54+
//| For more a more thorough explanation and guide for using `displayio`, please
55+
//| refer to `this Learn guide
56+
//| <https://learn.adafruit.com/circuitpython-display-support-using-displayio>`_.
5757
//| """
5858
//|
5959

‎shared-bindings/neopixel_write/__init__.c‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,11 +97,11 @@ STATIC void check_for_deinit(digitalio_digitalinout_obj_t *self) {
9797
//|
9898
//| This library is typically not used by user level code.
9999
//|
100-
//| For more information on actually using NeoPixels, refer to the CircuitPython
101-
//| Essentials Learn guide: https://learn.adafruit.com/circuitpython-essentials/circuitpython-neopixel
100+
//| For more information on actually using NeoPixels, refer to the `CircuitPython
101+
//| Essentials Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-neopixel>`_
102102
//|
103-
//| For a much more thorough guide about using NeoPixels, refer to the Adadfruit NeoPixel Überguide:
104-
//| https://learn.adafruit.com/adafruit-neopixel-uberguide
103+
//| For a much more thorough guide about using NeoPixels, refer to the `Adafruit NeoPixel Überguide
104+
//| <https://learn.adafruit.com/adafruit-neopixel-uberguide>`_.
105105
//|
106106
//| """
107107
//|

‎shared-bindings/pwmio/__init__.c‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,8 @@
5959
//| hardware after program completion. Use ``deinit()`` or a ``with`` statement
6060
//| to do it yourself.
6161
//|
62-
//| For the essentials of `pwmio`, see the CircuitPython Essentials
63-
//| Learn guide:
64-
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-pwm
62+
//| For the essentials of `pwmio`, see the `CircuitPython Essentials
63+
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-pwm>`_.
6564
//| """
6665
//|
6766

‎shared-bindings/storage/__init__.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@
4242
//| CircuitPython does not have an OS, so this module provides this functionality
4343
//| directly.
4444

45-
//| For more information regarding using the `storage` module, refer to the CircuitPython
46-
//| Essentials Learn guide:
47-
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage
45+
//| For more information regarding using the `storage` module, refer to the `CircuitPython
46+
//| Essentials Learn guide
47+
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage>`_.
4848
//| """
4949
//|
5050

0 commit comments

Comments
 (0)