Browse Source

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.
pull/2168/merge
Paul Sokolovsky 9 years ago
parent
commit
0a4cc24b2e
  1. 1
      docs/library/pyb.ADC.rst
  2. 2
      docs/library/pyb.Accel.rst
  3. 2
      docs/library/pyb.CAN.rst
  4. 1
      docs/library/pyb.DAC.rst
  5. 1
      docs/library/pyb.ExtInt.rst
  6. 1
      docs/library/pyb.I2C.rst
  7. 2
      docs/library/pyb.LCD.rst
  8. 1
      docs/library/pyb.LED.rst
  9. 1
      docs/library/pyb.Pin.rst
  10. 1
      docs/library/pyb.RTC.rst
  11. 1
      docs/library/pyb.SPI.rst
  12. 1
      docs/library/pyb.Servo.rst
  13. 2
      docs/library/pyb.Switch.rst
  14. 1
      docs/library/pyb.Timer.rst
  15. 1
      docs/library/pyb.UART.rst
  16. 2
      docs/library/pyb.USB_VCP.rst

1
docs/library/pyb.ADC.rst

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

2
docs/library/pyb.Accel.rst

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

2
docs/library/pyb.CAN.rst

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

1
docs/library/pyb.DAC.rst

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

1
docs/library/pyb.ExtInt.rst

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

1
docs/library/pyb.I2C.rst

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

2
docs/library/pyb.LCD.rst

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

1
docs/library/pyb.LED.rst

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

1
docs/library/pyb.Pin.rst

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

1
docs/library/pyb.RTC.rst

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

1
docs/library/pyb.SPI.rst

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

1
docs/library/pyb.Servo.rst

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

2
docs/library/pyb.Switch.rst

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

1
docs/library/pyb.Timer.rst

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

1
docs/library/pyb.UART.rst

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

2
docs/library/pyb.USB_VCP.rst

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

Loading…
Cancel
Save