Commit 0a4cc24b authored by Paul Sokolovsky's avatar Paul Sokolovsky
Browse files

docs/pyb.*: Add "currentmodule:: pyb" directive.

Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
parent c8b76280
.. currentmodule:: pyb
.. _pyb.ADC: .. _pyb.ADC:
class ADC -- analog to digital conversion class ADC -- analog to digital conversion
......
.. currentmodule:: pyb
class Accel -- accelerometer control class Accel -- accelerometer control
==================================== ====================================
......
.. currentmodule:: pyb
class CAN -- controller area network communication bus class CAN -- controller area network communication bus
====================================================== ======================================================
......
.. currentmodule:: pyb
.. _pyb.DAC: .. _pyb.DAC:
class DAC -- digital to analog conversion class DAC -- digital to analog conversion
......
.. currentmodule:: pyb
.. _pyb.ExtInt: .. _pyb.ExtInt:
class ExtInt -- configure I/O pins to interrupt on external events class ExtInt -- configure I/O pins to interrupt on external events
......
.. currentmodule:: pyb
.. _pyb.I2C: .. _pyb.I2C:
class I2C -- a two-wire serial protocol class I2C -- a two-wire serial protocol
......
.. currentmodule:: pyb
class LCD -- LCD control for the LCD touch-sensor pyskin class LCD -- LCD control for the LCD touch-sensor pyskin
======================================================== ========================================================
......
.. currentmodule:: pyb
.. _pyb.LED: .. _pyb.LED:
class LED -- LED object class LED -- LED object
......
.. currentmodule:: pyb
.. _pyb.Pin: .. _pyb.Pin:
class Pin -- control I/O pins class Pin -- control I/O pins
......
.. currentmodule:: pyb
.. _pyb.RTC: .. _pyb.RTC:
class RTC -- real time clock class RTC -- real time clock
......
.. currentmodule:: pyb
.. _pyb.SPI: .. _pyb.SPI:
class SPI -- a master-driven serial protocol class SPI -- a master-driven serial protocol
......
.. currentmodule:: pyb
.. _pyb.Servo: .. _pyb.Servo:
class Servo -- 3-wire hobby servo driver class Servo -- 3-wire hobby servo driver
......
.. currentmodule:: pyb
class Switch -- switch object class Switch -- switch object
============================= =============================
......
.. currentmodule:: pyb
.. _pyb.Timer: .. _pyb.Timer:
class Timer -- control internal timers class Timer -- control internal timers
......
.. currentmodule:: pyb
.. _pyb.UART: .. _pyb.UART:
class UART -- duplex serial communication bus class UART -- duplex serial communication bus
......
.. currentmodule:: pyb
class USB_VCP -- USB virtual comm port class USB_VCP -- USB virtual comm port
====================================== ======================================
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment