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.
This commit is contained in:
Paul Sokolovsky 2016-06-08 00:57:41 +03:00
parent c8b7628094
commit 0a4cc24b2e
16 changed files with 21 additions and 0 deletions

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.ADC:
class ADC -- analog to digital conversion

View File

@ -1,3 +1,5 @@
.. currentmodule:: pyb
class Accel -- accelerometer control
====================================

View File

@ -1,3 +1,5 @@
.. currentmodule:: pyb
class CAN -- controller area network communication bus
======================================================

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.DAC:
class DAC -- digital to analog conversion

View File

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

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.I2C:
class I2C -- a two-wire serial protocol

View File

@ -1,3 +1,5 @@
.. currentmodule:: pyb
class LCD -- LCD control for the LCD touch-sensor pyskin
========================================================

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.LED:
class LED -- LED object

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.Pin:
class Pin -- control I/O pins

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.RTC:
class RTC -- real time clock

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.SPI:
class SPI -- a master-driven serial protocol

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.Servo:
class Servo -- 3-wire hobby servo driver

View File

@ -1,3 +1,5 @@
.. currentmodule:: pyb
class Switch -- switch object
=============================

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.Timer:
class Timer -- control internal timers

View File

@ -1,3 +1,4 @@
.. currentmodule:: pyb
.. _pyb.UART:
class UART -- duplex serial communication bus

View File

@ -1,3 +1,5 @@
.. currentmodule:: pyb
class USB_VCP -- USB virtual comm port
======================================