djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Damien George 2018-07-20 15:58:18 +10:00
parent 0ab8428995
commit 81e320aecc
2 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/library/machine.SD.rst
View File

@ -4,6 +4,11 @@
class SD -- secure digital memory card 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 The SD card class allows to configure and enable the memory card
module of the WiPy and automatically mount it as ``/sd`` as part module of the WiPy and automatically mount it as ``/sd`` as part
of the file system. There are several pin combinations that can be of the file system. There are several pin combinations that can be

29
docs/library/machine.rst
View File

@ -140,31 +140,16 @@ Constants
Classes Classes
------- -------
.. only:: not port_wipy .. toctree::
.. toctree::
:maxdepth: 1 :maxdepth: 1
machine.Pin.rst machine.Pin.rst
machine.Signal.rst machine.Signal.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.ADC.rst
machine.UART.rst
machine.SPI.rst
machine.I2C.rst
machine.RTC.rst
machine.Timer.rst
machine.WDT.rst
machine.SD.rst machine.SD.rst