Skip to content

Commit 0a4cc24

Browse files
committed
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.
1 parent c8b7628 commit 0a4cc24

16 files changed

+21
-0
lines changed

docs/library/pyb.ADC.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.ADC:
23

34
class ADC -- analog to digital conversion

docs/library/pyb.Accel.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. currentmodule:: pyb
2+
13
class Accel -- accelerometer control
24
====================================
35

docs/library/pyb.CAN.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. currentmodule:: pyb
2+
13
class CAN -- controller area network communication bus
24
======================================================
35

docs/library/pyb.DAC.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.DAC:
23

34
class DAC -- digital to analog conversion

docs/library/pyb.ExtInt.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.ExtInt:
23

34
class ExtInt -- configure I/O pins to interrupt on external events

docs/library/pyb.I2C.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.I2C:
23

34
class I2C -- a two-wire serial protocol

docs/library/pyb.LCD.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. currentmodule:: pyb
2+
13
class LCD -- LCD control for the LCD touch-sensor pyskin
24
========================================================
35

docs/library/pyb.LED.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.LED:
23

34
class LED -- LED object

docs/library/pyb.Pin.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.Pin:
23

34
class Pin -- control I/O pins

docs/library/pyb.RTC.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: pyb
12
.. _pyb.RTC:
23

34
class RTC -- real time clock

0 commit comments

Comments
 (0)