summaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2018-07-20 15:58:18 +1000
committerDamien George <damien.p.george@gmail.com>2018-07-20 15:58:18 +1000
commit81e320aecc2c7e21235244ade084ba4f71ff40e7 (patch)
tree0e1ef1cb39245ff6c317f5f7ed74ab0373388678 /docs
parent0ab84289952a9a9b7f35a89943f1e8e1ddd11696 (diff)
downloadmicropython-81e320aecc2c7e21235244ade084ba4f71ff40e7.tar.gz
micropython-81e320aecc2c7e21235244ade084ba4f71ff40e7.zip
docs/library/machine: Remove conditionals in machine class index.
The machine module should be standard across all ports so should have the same set of classes in the docs. A special warning is added to the top of the machine.SD class because it is not standardised and only available on the cc3200 port.
Diffstat (limited to 'docs')
-rw-r--r--docs/library/machine.SD.rst5
-rw-r--r--docs/library/machine.rst19
2 files changed, 7 insertions, 17 deletions
diff --git a/docs/library/machine.SD.rst b/docs/library/machine.SD.rst
index 608e958317..9c58e73545 100644
--- a/docs/library/machine.SD.rst
+++ b/docs/library/machine.SD.rst
@@ -4,6 +4,11 @@
class SD -- secure digital memory card
======================================
+.. warning::
+
+ This is a non-standard class and is only available on the cc3200 port.
+
+
The SD card class allows to configure and enable the memory card
module of the WiPy and automatically mount it as ``/sd`` as part
of the file system. There are several pin combinations that can be
diff --git a/docs/library/machine.rst b/docs/library/machine.rst
index e5f9b39063..f734cccc37 100644
--- a/docs/library/machine.rst
+++ b/docs/library/machine.rst
@@ -140,31 +140,16 @@ Constants
Classes
-------
-.. only:: not port_wipy
-
- .. toctree::
+.. toctree::
:maxdepth: 1
machine.Pin.rst
machine.Signal.rst
+ machine.ADC.rst
machine.UART.rst
machine.SPI.rst
machine.I2C.rst
machine.RTC.rst
machine.Timer.rst
machine.WDT.rst
-
-.. only:: port_wipy
-
- .. toctree::
- :maxdepth: 1
-
- machine.Pin.rst
- machine.UART.rst
- machine.SPI.rst
- machine.I2C.rst
- machine.RTC.rst
- machine.Timer.rst
- machine.WDT.rst
- machine.ADC.rst
machine.SD.rst