djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Add links from quickref to pyb classes.

This commit is contained in:
Damien George 2014-11-04 18:25:20 +00:00
parent bc0bc764fc
commit 8e701604d5
10 changed files with 40 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/library/pyb.ADC.rst
View File

@ -1,3 +1,5 @@
.. _pyb.ADC:
class ADC -- analog to digital conversion: read analog values on a pin
======================================================================

2
docs/library/pyb.DAC.rst
View File

@ -1,3 +1,5 @@
.. _pyb.DAC:
class DAC -- digital to analog conversion
=========================================

2
docs/library/pyb.ExtInt.rst
View File

@ -1,3 +1,5 @@
.. _pyb.ExtInt:
class ExtInt -- configure I/O pins to interrupt on external events
==================================================================

2
docs/library/pyb.I2C.rst
View File

@ -1,3 +1,5 @@
.. _pyb.I2C:
class I2C -- a two-wire serial protocol
=======================================

2
docs/library/pyb.LED.rst
View File

@ -1,3 +1,5 @@
.. _pyb.LED:
class LED -- LED object
=======================

2
docs/library/pyb.Pin.rst
View File

@ -1,3 +1,5 @@
.. _pyb.Pin:
class Pin -- control I/O pins
=============================

2
docs/library/pyb.SPI.rst
View File

@ -1,3 +1,5 @@
.. _pyb.SPI:
class SPI -- a master-driven serial protocol
============================================

2
docs/library/pyb.Timer.rst
View File

@ -1,3 +1,5 @@
.. _pyb.Timer:
class Timer -- control internal timers
======================================

2
docs/library/pyb.UART.rst
View File

@ -1,3 +1,5 @@
.. _pyb.UART:
class UART -- duplex serial communication bus
=============================================

33
docs/quickref.rst
View File

@ -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