summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 00:57:41 +0300
committerPaul Sokolovsky <pfalcon@users.sourceforge.net>2016-06-08 00:57:41 +0300
commit0a4cc24b2e8e7ceafb4e2cbe640c9f5dce655a70 (patch)
tree0e2336e67e888de437a479f34bae262680fddbd4 /docs
parentc8b7628094528cb8b68de499165db5bfb0b1264b (diff)
downloadmicropython-0a4cc24b2e8e7ceafb4e2cbe640c9f5dce655a70.tar.gz
micropython-0a4cc24b2e8e7ceafb4e2cbe640c9f5dce655a70.zip
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.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/pyb.ADC.rst1
-rw-r--r--docs/library/pyb.Accel.rst2
-rw-r--r--docs/library/pyb.CAN.rst2
-rw-r--r--docs/library/pyb.DAC.rst1
-rw-r--r--docs/library/pyb.ExtInt.rst1
-rw-r--r--docs/library/pyb.I2C.rst1
-rw-r--r--docs/library/pyb.LCD.rst2
-rw-r--r--docs/library/pyb.LED.rst1
-rw-r--r--docs/library/pyb.Pin.rst1
-rw-r--r--docs/library/pyb.RTC.rst1
-rw-r--r--docs/library/pyb.SPI.rst1
-rw-r--r--docs/library/pyb.Servo.rst1
-rw-r--r--docs/library/pyb.Switch.rst2
-rw-r--r--docs/library/pyb.Timer.rst1
-rw-r--r--docs/library/pyb.UART.rst1
-rw-r--r--docs/library/pyb.USB_VCP.rst2
16 files changed, 21 insertions, 0 deletions
diff --git a/docs/library/pyb.ADC.rst b/docs/library/pyb.ADC.rst
index 30957c4c1a..e75efae7b5 100644
--- a/docs/library/pyb.ADC.rst
+++ b/docs/library/pyb.ADC.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.ADC:
class ADC -- analog to digital conversion
diff --git a/docs/library/pyb.Accel.rst b/docs/library/pyb.Accel.rst
index fd96ec35f9..53e410dfb9 100644
--- a/docs/library/pyb.Accel.rst
+++ b/docs/library/pyb.Accel.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class Accel -- accelerometer control
====================================
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst
index e5d2b9acb1..efa2f19d50 100644
--- a/docs/library/pyb.CAN.rst
+++ b/docs/library/pyb.CAN.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class CAN -- controller area network communication bus
======================================================
diff --git a/docs/library/pyb.DAC.rst b/docs/library/pyb.DAC.rst
index 7b5b1a6821..02c85fdd1b 100644
--- a/docs/library/pyb.DAC.rst
+++ b/docs/library/pyb.DAC.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.DAC:
class DAC -- digital to analog conversion
diff --git a/docs/library/pyb.ExtInt.rst b/docs/library/pyb.ExtInt.rst
index 61023ebb38..8344a14c2e 100644
--- a/docs/library/pyb.ExtInt.rst
+++ b/docs/library/pyb.ExtInt.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.ExtInt:
class ExtInt -- configure I/O pins to interrupt on external events
diff --git a/docs/library/pyb.I2C.rst b/docs/library/pyb.I2C.rst
index 9d17bb0559..d8eb8655c6 100644
--- a/docs/library/pyb.I2C.rst
+++ b/docs/library/pyb.I2C.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.I2C:
class I2C -- a two-wire serial protocol
diff --git a/docs/library/pyb.LCD.rst b/docs/library/pyb.LCD.rst
index 7555b6fb09..06fe35589d 100644
--- a/docs/library/pyb.LCD.rst
+++ b/docs/library/pyb.LCD.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class LCD -- LCD control for the LCD touch-sensor pyskin
========================================================
diff --git a/docs/library/pyb.LED.rst b/docs/library/pyb.LED.rst
index aeeb75b8f1..fd997e40f7 100644
--- a/docs/library/pyb.LED.rst
+++ b/docs/library/pyb.LED.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.LED:
class LED -- LED object
diff --git a/docs/library/pyb.Pin.rst b/docs/library/pyb.Pin.rst
index 30440f5025..65ae601bed 100644
--- a/docs/library/pyb.Pin.rst
+++ b/docs/library/pyb.Pin.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.Pin:
class Pin -- control I/O pins
diff --git a/docs/library/pyb.RTC.rst b/docs/library/pyb.RTC.rst
index 51b17deccf..19401b9823 100644
--- a/docs/library/pyb.RTC.rst
+++ b/docs/library/pyb.RTC.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.RTC:
class RTC -- real time clock
diff --git a/docs/library/pyb.SPI.rst b/docs/library/pyb.SPI.rst
index b17c804d70..0b5546513b 100644
--- a/docs/library/pyb.SPI.rst
+++ b/docs/library/pyb.SPI.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.SPI:
class SPI -- a master-driven serial protocol
diff --git a/docs/library/pyb.Servo.rst b/docs/library/pyb.Servo.rst
index cea31fd28e..da117c8076 100644
--- a/docs/library/pyb.Servo.rst
+++ b/docs/library/pyb.Servo.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.Servo:
class Servo -- 3-wire hobby servo driver
diff --git a/docs/library/pyb.Switch.rst b/docs/library/pyb.Switch.rst
index daaed19420..a9aef4e2ec 100644
--- a/docs/library/pyb.Switch.rst
+++ b/docs/library/pyb.Switch.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class Switch -- switch object
=============================
diff --git a/docs/library/pyb.Timer.rst b/docs/library/pyb.Timer.rst
index d2a299bd29..a709e11bf7 100644
--- a/docs/library/pyb.Timer.rst
+++ b/docs/library/pyb.Timer.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.Timer:
class Timer -- control internal timers
diff --git a/docs/library/pyb.UART.rst b/docs/library/pyb.UART.rst
index 536b6f467d..3aa07b7356 100644
--- a/docs/library/pyb.UART.rst
+++ b/docs/library/pyb.UART.rst
@@ -1,3 +1,4 @@
+.. currentmodule:: pyb
.. _pyb.UART:
class UART -- duplex serial communication bus
diff --git a/docs/library/pyb.USB_VCP.rst b/docs/library/pyb.USB_VCP.rst
index cc4dbe5903..6a77f1eae3 100644
--- a/docs/library/pyb.USB_VCP.rst
+++ b/docs/library/pyb.USB_VCP.rst
@@ -1,3 +1,5 @@
+.. currentmodule:: pyb
+
class USB_VCP -- USB virtual comm port
======================================