docs: Add links from quickref to pyb classes.

dpgeorge · dpgeorge · commit 8e701604d570 · 2014-11-04T18:25:20.000Z
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -1,3 +1,5 @@
+.. _pyb.LED:
+
 class LED -- LED object
 =======================
 
diff --git 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
@@ -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
@@ -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
@@ -1,3 +1,5 @@
+.. _pyb.UART:
+
 class UART -- duplex serial communication bus
 =============================================
 
diff --git 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
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.ADC:`
	`2`	`+`
`1`	`3`	`class ADC -- analog to digital conversion: read analog values on a pin`
`2`	`4`	`======================================================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.DAC:`
	`2`	`+`
`1`	`3`	`class DAC -- digital to analog conversion`
`2`	`4`	`=========================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.ExtInt:`
	`2`	`+`
`1`	`3`	`class ExtInt -- configure I/O pins to interrupt on external events`
`2`	`4`	`==================================================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.I2C:`
	`2`	`+`
`1`	`3`	`class I2C -- a two-wire serial protocol`
`2`	`4`	`=======================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.LED:`
	`2`	`+`
`1`	`3`	`class LED -- LED object`
`2`	`4`	`=======================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.Pin:`
	`2`	`+`
`1`	`3`	`class Pin -- control I/O pins`
`2`	`4`	`=============================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.SPI:`
	`2`	`+`
`1`	`3`	`class SPI -- a master-driven serial protocol`
`2`	`4`	`============================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.Timer:`
	`2`	`+`
`1`	`3`	`class Timer -- control internal timers`
`2`	`4`	`======================================`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+.. _pyb.UART:`
	`2`	`+`
`1`	`3`	`class UART -- duplex serial communication bus`
`2`	`4`	`=============================================`
`3`	`5`