From c8b7628094528cb8b68de499165db5bfb0b1264b Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Wed, 8 Jun 2016 00:46:27 +0300 Subject: [PATCH] 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. --- docs/library/machine.ADC.rst | 1 + docs/library/machine.I2C.rst | 1 + docs/library/machine.Pin.rst | 1 + docs/library/machine.RTC.rst | 1 + docs/library/machine.SD.rst | 1 + docs/library/machine.SPI.rst | 1 + docs/library/machine.Timer.rst | 1 + docs/library/machine.UART.rst | 1 + docs/library/machine.WDT.rst | 1 + 9 files changed, 9 insertions(+) diff --git a/docs/library/machine.ADC.rst b/docs/library/machine.ADC.rst index 309d070b1b..ef545f35f3 100644 --- a/docs/library/machine.ADC.rst +++ b/docs/library/machine.ADC.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.ADC: class ADC -- analog to digital conversion diff --git a/docs/library/machine.I2C.rst b/docs/library/machine.I2C.rst index a7e90ca39b..c83c436ad9 100644 --- a/docs/library/machine.I2C.rst +++ b/docs/library/machine.I2C.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.I2C: class I2C -- a two-wire serial protocol diff --git a/docs/library/machine.Pin.rst b/docs/library/machine.Pin.rst index 053c6e79b3..2d3385b065 100644 --- a/docs/library/machine.Pin.rst +++ b/docs/library/machine.Pin.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.Pin: class Pin -- control I/O pins diff --git a/docs/library/machine.RTC.rst b/docs/library/machine.RTC.rst index c69e4781a2..684f31aa0f 100644 --- a/docs/library/machine.RTC.rst +++ b/docs/library/machine.RTC.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.RTC: class RTC -- real time clock diff --git a/docs/library/machine.SD.rst b/docs/library/machine.SD.rst index da60121d07..d1a3b4e358 100644 --- a/docs/library/machine.SD.rst +++ b/docs/library/machine.SD.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.SD: class SD -- secure digital memory card diff --git a/docs/library/machine.SPI.rst b/docs/library/machine.SPI.rst index eddd62dbdc..285cd37b4b 100644 --- a/docs/library/machine.SPI.rst +++ b/docs/library/machine.SPI.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.SPI: class SPI -- a master-driven serial protocol diff --git a/docs/library/machine.Timer.rst b/docs/library/machine.Timer.rst index daf63c9b93..8bb9a36600 100644 --- a/docs/library/machine.Timer.rst +++ b/docs/library/machine.Timer.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.Timer: class Timer -- control internal timers diff --git a/docs/library/machine.UART.rst b/docs/library/machine.UART.rst index 7399b9b6e9..5552b9dd72 100644 --- a/docs/library/machine.UART.rst +++ b/docs/library/machine.UART.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.UART: class UART -- duplex serial communication bus diff --git a/docs/library/machine.WDT.rst b/docs/library/machine.WDT.rst index dca74f70f6..10e6af0e14 100644 --- a/docs/library/machine.WDT.rst +++ b/docs/library/machine.WDT.rst @@ -1,3 +1,4 @@ +.. currentmodule:: machine .. _machine.WDT: class WDT -- watchdog timer