summaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--docs/library/pyb.ADC.rst2
-rw-r--r--docs/library/pyb.DAC.rst2
-rw-r--r--docs/library/pyb.ExtInt.rst2
-rw-r--r--docs/library/pyb.I2C.rst2
-rw-r--r--docs/library/pyb.LED.rst2
-rw-r--r--docs/library/pyb.Pin.rst2
-rw-r--r--docs/library/pyb.SPI.rst2
-rw-r--r--docs/library/pyb.Timer.rst2
-rw-r--r--docs/library/pyb.UART.rst2
-rw-r--r--docs/quickref.rst33
10 files changed, 40 insertions, 11 deletions
diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst
index 33e587f3fa..cc0934427f 100644
--- a/docs/library/pyb.ADC.rst
+++ b/docs/library/pyb.ADC.rst
@@ -1,3 +1,5 @@
+.. _pyb.ADC:
+
class ADC -- analog to digital conversion: read analog values on a pin
======================================================================
diff --git a/docs/library/pyb.DAC.rst b/docs/library/pyb.DAC.rst
index 00be855d5a..393daf38b6 100644
--- a/docs/library/pyb.DAC.rst
+++ b/docs/library/pyb.DAC.rst
@@ -1,3 +1,5 @@
+.. _pyb.DAC:
+
class DAC -- digital to analog conversion
=========================================
diff --git a/docs/library/pyb.ExtInt.rst b/docs/library/pyb.ExtInt.rst
index ac31aebb40..61023ebb38 100644
--- a/docs/library/pyb.ExtInt.rst
+++ b/docs/library/pyb.ExtInt.rst
@@ -1,3 +1,5 @@
+.. _pyb.ExtInt:
+
class ExtInt -- configure I/O pins to interrupt on external events
==================================================================
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst
index e85bcef866..1eb426168c 100644
--- a/docs/library/pyb.I2C.rst
+++ b/docs/library/pyb.I2C.rst
@@ -1,3 +1,5 @@
+.. _pyb.I2C:
+
class I2C -- a two-wire serial protocol
=======================================
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index 227450f482..02fc132463 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -1,3 +1,5 @@
+.. _pyb.LED:
+
class LED -- LED object
=======================
diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst
index 010996acf4..6f04378b6e 100644
--- a/docs/library/pyb.Pin.rst
+++ b/docs/library/pyb.Pin.rst
@@ -1,3 +1,5 @@
+.. _pyb.Pin:
+
class Pin -- control I/O pins
=============================
diff --git a/docs/library/pyb.SPI.rst b/docs/library/pyb.SPI.rst
index 7b765e6b06..5c732fccba 100644
--- a/docs/library/pyb.SPI.rst
+++ b/docs/library/pyb.SPI.rst
@@ -1,3 +1,5 @@
+.. _pyb.SPI:
+
class SPI -- a master-driven serial protocol
============================================
diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst
index 96ea48f0dc..017ea56c5c 100644
--- a/docs/library/pyb.Timer.rst
+++ b/docs/library/pyb.Timer.rst
@@ -1,3 +1,5 @@
+.. _pyb.Timer:
+
class Timer -- control internal timers
======================================
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst
index 66f5cc5da2..a636e65e30 100644
--- a/docs/library/pyb.UART.rst
+++ b/docs/library/pyb.UART.rst
@@ -1,3 +1,5 @@
+.. _pyb.UART:
+
class UART -- duplex serial communication bus
=============================================
diff --git a/docs/quickref.rst b/docs/quickref.rst
index 1aaddadc00..5c3c7a7b2c 100644
--- a/docs/quickref.rst
+++ b/docs/quickref.rst
@@ -9,7 +9,8 @@ Quick reference for the pyboard
General board control
---------------------
-::
+
+See :mod:`pyb`. ::
import pyb
@@ -23,7 +24,8 @@ General board control
LEDs
----
-::
+
+See :ref:`pyb.LED <pyb.LED>`. ::
from pyb import LED
@@ -34,7 +36,8 @@ LEDs
Pins and GPIO
-------------
-::
+
+See :ref:`pyb.Pin <pyb.Pin>`. ::
from pyb import Pin
@@ -47,7 +50,8 @@ Pins and GPIO
External interrupts
-------------------
-::
+
+See :ref:`pyb.ExtInt <pyb.ExtInt>`. ::
from pyb import Pin, ExtInt
@@ -56,7 +60,8 @@ External interrupts
Timers
------
-::
+
+See :ref:`pyb.Timer <pyb.Timer>`. ::
from pyb import Timer
@@ -67,7 +72,8 @@ Timers
PWM (pulse width modulation)
----------------------------
-::
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.Timer <pyb.Timer>`. ::
from pyb import Pin, Timer
@@ -78,7 +84,8 @@ PWM (pulse width modulation)
ADC (analog to digital conversion)
----------------------------------
-::
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.ADC <pyb.ADC>`. ::
from pyb import Pin, ADC
@@ -87,7 +94,8 @@ ADC (analog to digital conversion)
DAC (digital to analog conversion)
----------------------------------
-::
+
+See :ref:`pyb.Pin <pyb.Pin>` and :ref:`pyb.DAC <pyb.DAC>`. ::
from pyb import Pin, DAC
@@ -96,7 +104,8 @@ DAC (digital to analog conversion)
UART (serial bus)
-----------------
-::
+
+See :ref:`pyb.UART <pyb.UART>`. ::
from pyb import UART
@@ -106,7 +115,8 @@ UART (serial bus)
SPI bus
-------
-::
+
+See :ref:`pyb.SPI <pyb.SPI>`. ::
from pyb import SPI
@@ -117,7 +127,8 @@ SPI bus
I2C bus
-------
-::
+
+See :ref:`pyb.I2C <pyb.I2C>`. ::
from pyb import I2C