Make other documentation links prettier

This commit is contained in:
Alec Delaney 2022-05-13 11:51:30 -04:00
parent 82810085b5
commit cb3932ce29
7 changed files with 23 additions and 26 deletions

View File

@ -59,12 +59,11 @@
//| :py:meth:`~analogio.AnalogIn.deinit` the hardware. The last step is optional
//| because CircuitPython will do it automatically after the program finishes.
//|
//| For the essentials of `analogio`, see the CircuitPython Essentials
//| Learn guide:
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-analog-in
//| For the essentials of `analogio`, see the `CircuitPython Essentials
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-analog-in>`_
//|
//| For more information on using `analogio`, see this additional Learn guide:
//| https://learn.adafruit.com/circuitpython-basics-analog-inputs-and-outputs
//| For more information on using `analogio`, see `this additional Learn guide
//| <https://learn.adafruit.com/circuitpython-basics-analog-inputs-and-outputs>`_
//| """
//|

View File

@ -47,9 +47,9 @@
//| the default pins and settings. For more information about serial communcication
//| in CircuitPython, see the :mod:`busio`.
//|
//| For more information regarding the typical usage of :py:mod:`board`, refer to the CircuitPython
//| Essentials Learn guide:
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules
//| For more information regarding the typical usage of :py:mod:`board`, refer to the `CircuitPython
//| Essentials Learn guide
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-pins-and-modules>`_
//|
//| .. warning:: The board module varies by board. The APIs documented here may or may not be
//| available on a specific board."""

View File

@ -73,12 +73,11 @@
//| led.value = False
//| time.sleep(0.1)
//|
//| For the essentials of `digitalio`, see the CircuitPython Essentials
//| Learn guide:
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-digital-in-out
//| For the essentials of `digitalio`, see the `CircuitPython Essentials
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-digital-in-out>`_
//|
//| For more information on using `digitalio`, see this additional Learn guide:
//| https://learn.adafruit.com/circuitpython-digital-inputs-and-outputs
//| For more information on using `digitalio`, see `this additional Learn guide
//| <https://learn.adafruit.com/circuitpython-digital-inputs-and-outputs>`_
//| """
STATIC const mp_rom_map_elem_t digitalio_module_globals_table[] = {

View File

@ -51,9 +51,9 @@
//| The `displayio` module contains classes to manage display output
//| including synchronizing with refresh rates and partial updating.
//|
//| For more a more thorugh explanation and guide for using `displayio`, please
//| refer to this Learn guide:
//| https://learn.adafruit.com/circuitpython-display-support-using-displayio
//| For more a more thorough explanation and guide for using `displayio`, please
//| refer to `this Learn guide
//| <https://learn.adafruit.com/circuitpython-display-support-using-displayio>`_.
//| """
//|

View File

@ -97,11 +97,11 @@ STATIC void check_for_deinit(digitalio_digitalinout_obj_t *self) {
//|
//| This library is typically not used by user level code.
//|
//| For more information on actually using NeoPixels, refer to the CircuitPython
//| Essentials Learn guide: https://learn.adafruit.com/circuitpython-essentials/circuitpython-neopixel
//| For more information on actually using NeoPixels, refer to the `CircuitPython
//| Essentials Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-neopixel>`_
//|
//| For a much more thorough guide about using NeoPixels, refer to the Adadfruit NeoPixel Überguide:
//| https://learn.adafruit.com/adafruit-neopixel-uberguide
//| For a much more thorough guide about using NeoPixels, refer to the `Adafruit NeoPixel Überguide
//| <https://learn.adafruit.com/adafruit-neopixel-uberguide>`_.
//|
//| """
//|

View File

@ -59,9 +59,8 @@
//| hardware after program completion. Use ``deinit()`` or a ``with`` statement
//| to do it yourself.
//|
//| For the essentials of `pwmio`, see the CircuitPython Essentials
//| Learn guide:
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-pwm
//| For the essentials of `pwmio`, see the `CircuitPython Essentials
//| Learn guide <https://learn.adafruit.com/circuitpython-essentials/circuitpython-pwm>`_.
//| """
//|

View File

@ -42,9 +42,9 @@
//| CircuitPython does not have an OS, so this module provides this functionality
//| directly.
//| For more information regarding using the `storage` module, refer to the CircuitPython
//| Essentials Learn guide:
//| https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage
//| For more information regarding using the `storage` module, refer to the `CircuitPython
//| Essentials Learn guide
//| <https://learn.adafruit.com/circuitpython-essentials/circuitpython-storage>`_.
//| """
//|