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:
parent
c8b7628094
commit
0a4cc24b2e
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.ADC:
|
.. _pyb.ADC:
|
||||||
|
|
||||||
class ADC -- analog to digital conversion
|
class ADC -- analog to digital conversion
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
|
|
||||||
class Accel -- accelerometer control
|
class Accel -- accelerometer control
|
||||||
====================================
|
====================================
|
||||||
|
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
|
|
||||||
class CAN -- controller area network communication bus
|
class CAN -- controller area network communication bus
|
||||||
======================================================
|
======================================================
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.DAC:
|
.. _pyb.DAC:
|
||||||
|
|
||||||
class DAC -- digital to analog conversion
|
class DAC -- digital to analog conversion
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. 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
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.I2C:
|
.. _pyb.I2C:
|
||||||
|
|
||||||
class I2C -- a two-wire serial protocol
|
class I2C -- a two-wire serial protocol
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
|
|
||||||
class LCD -- LCD control for the LCD touch-sensor pyskin
|
class LCD -- LCD control for the LCD touch-sensor pyskin
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.LED:
|
.. _pyb.LED:
|
||||||
|
|
||||||
class LED -- LED object
|
class LED -- LED object
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.Pin:
|
.. _pyb.Pin:
|
||||||
|
|
||||||
class Pin -- control I/O pins
|
class Pin -- control I/O pins
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.RTC:
|
.. _pyb.RTC:
|
||||||
|
|
||||||
class RTC -- real time clock
|
class RTC -- real time clock
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.SPI:
|
.. _pyb.SPI:
|
||||||
|
|
||||||
class SPI -- a master-driven serial protocol
|
class SPI -- a master-driven serial protocol
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.Servo:
|
.. _pyb.Servo:
|
||||||
|
|
||||||
class Servo -- 3-wire hobby servo driver
|
class Servo -- 3-wire hobby servo driver
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
|
|
||||||
class Switch -- switch object
|
class Switch -- switch object
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.Timer:
|
.. _pyb.Timer:
|
||||||
|
|
||||||
class Timer -- control internal timers
|
class Timer -- control internal timers
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
.. _pyb.UART:
|
.. _pyb.UART:
|
||||||
|
|
||||||
class UART -- duplex serial communication bus
|
class UART -- duplex serial communication bus
|
||||||
|
@ -1,3 +1,5 @@
|
|||||||
|
.. currentmodule:: pyb
|
||||||
|
|
||||||
class USB_VCP -- USB virtual comm port
|
class USB_VCP -- USB virtual comm port
|
||||||
======================================
|
======================================
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user