Skip to content

Commit c8b7628

Browse files
committed
docs/machine.*: Add "currentmodule:: machine" directive.
Makes sure that classes described in these separate files are properly designated as belonging to "machine" module in indexes.
1 parent 2c5fc68 commit c8b7628

File tree

9 files changed

+9
-0
lines changed

9 files changed

+9
-0
lines changed

docs/library/machine.ADC.rst

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

34
class ADC -- analog to digital conversion

docs/library/machine.I2C.rst

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

34
class I2C -- a two-wire serial protocol

docs/library/machine.Pin.rst

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

34
class Pin -- control I/O pins

docs/library/machine.RTC.rst

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

34
class RTC -- real time clock

docs/library/machine.SD.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: machine
12
.. _machine.SD:
23

34
class SD -- secure digital memory card

docs/library/machine.SPI.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: machine
12
.. _machine.SPI:
23

34
class SPI -- a master-driven serial protocol

docs/library/machine.Timer.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: machine
12
.. _machine.Timer:
23

34
class Timer -- control internal timers

docs/library/machine.UART.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: machine
12
.. _machine.UART:
23

34
class UART -- duplex serial communication bus

docs/library/machine.WDT.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.. currentmodule:: machine
12
.. _machine.WDT:
23

34
class WDT -- watchdog timer

0 commit comments

Comments
 (0)