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

docs/pyboard: Move hardware info into General Info chapter.

Browse Source 
This makes top-level ToC of the pyboard docs consistent with other ports
(consisting of 3 chapters: QuickRef, General Info, and Tutorial).

Also, some other minor tweaks applied, like local ToC for General Info and
headings mentioning pyboard.
This commit is contained in:
Paul Sokolovsky 2017-06-30 22:24:01 +03:00
parent e467949a4a
commit 4f23c5d587
5 changed files with 8 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/pyboard/general.rst
View File

@ -1,6 +1,8 @@
General information about the pyboard General information about the pyboard
===================================== =====================================
.. contents::
Local filesystem and SD card Local filesystem and SD card
---------------------------- ----------------------------
@ -67,3 +69,4 @@ There are currently 2 kinds of errors that you might see:
2. If all 4 LEDs cycle on and off slowly, then there was a hard fault. 2. If all 4 LEDs cycle on and off slowly, then there was a hard fault.
This cannot be recovered from and you need to do a hard reset. This cannot be recovered from and you need to do a hard reset.
.. include:: hardware/index.rst

6
docs/pyboard/hardware/index.rst
View File

@ -1,7 +1,7 @@
.. _hardware_index: .. _hardware_index:
The pyboard hardware The pyboard hardware
==================== --------------------
For the pyboard: For the pyboard:
@ -16,14 +16,14 @@ For the official skin modules:
* LCD160CRv1.0: see :mod:`lcd160cr` * LCD160CRv1.0: see :mod:`lcd160cr`
Datasheets for the components on the pyboard Datasheets for the components on the pyboard
============================================ --------------------------------------------
* The microcontroller: `STM32F405RGT6 <http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN1035/PF252144>`_ (link to manufacturer's site) * The microcontroller: `STM32F405RGT6 <http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN1035/PF252144>`_ (link to manufacturer's site)
* The accelerometer: `Freescale MMA7660 <http://micropython.org/resources/datasheets/MMA7660FC.pdf>`_ (800kiB PDF) * The accelerometer: `Freescale MMA7660 <http://micropython.org/resources/datasheets/MMA7660FC.pdf>`_ (800kiB PDF)
* The LDO voltage regulator: `Microchip MCP1802 <http://micropython.org/resources/datasheets/MCP1802-22053C.pdf>`_ (400kiB PDF) * The LDO voltage regulator: `Microchip MCP1802 <http://micropython.org/resources/datasheets/MCP1802-22053C.pdf>`_ (400kiB PDF)
Datasheets for other components Datasheets for other components
=============================== -------------------------------
* The LCD display on the LCD touch-sensor skin: `Newhaven Display NHD-C12832A1Z-FSW-FBW-3V3 <http://micropython.org/resources/datasheets/NHD-C12832A1Z-FSW-FBW-3V3.pdf>`_ (460KiB PDF) * The LCD display on the LCD touch-sensor skin: `Newhaven Display NHD-C12832A1Z-FSW-FBW-3V3 <http://micropython.org/resources/datasheets/NHD-C12832A1Z-FSW-FBW-3V3.pdf>`_ (460KiB PDF)
* The touch sensor chip on the LCD touch-sensor skin: `Freescale MPR121 <http://micropython.org/resources/datasheets/MPR121.pdf>`_ (280KiB PDF) * The touch sensor chip on the LCD touch-sensor skin: `Freescale MPR121 <http://micropython.org/resources/datasheets/MPR121.pdf>`_ (280KiB PDF)

4
docs/pyboard/tutorial/index.rst
View File

@ -1,7 +1,7 @@
.. _tutorial-index: .. _tutorial-index:
MicroPython tutorial MicroPython tutorial for the pyboard
==================== ====================================
This tutorial is intended to get you started with your pyboard. This tutorial is intended to get you started with your pyboard.
All you need is a pyboard and a micro-USB cable to connect it to All you need is a pyboard and a micro-USB cable to connect it to

1
docs/pyboard_index.rst
View File

@ -6,7 +6,6 @@ MicroPython documentation and references
pyboard/quickref.rst pyboard/quickref.rst
pyboard/general.rst pyboard/general.rst
pyboard/tutorial/index.rst pyboard/tutorial/index.rst
pyboard/hardware/index.rst
library/index.rst library/index.rst
reference/index.rst reference/index.rst
genrst/index.rst genrst/index.rst

4
docs/templates/topindex.html vendored
View File

@ -58,10 +58,6 @@
<span class="linkdescr">information about MicroPython specific language features</span> <span class="linkdescr">information about MicroPython specific language features</span>
</p> </p>
{% if port == "pyboard" %} {% if port == "pyboard" %}
<p class="biglink">
<a class="biglink" href="{{ pathto(port + "/hardware/index") }}">The {{ port }} hardware</a><br/>
<span class="linkdescr">schematics, dimensions and component datasheets</span>
</p>
<p class="biglink"> <p class="biglink">
<a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for {{ port_name }} on Windows (PDF)</a><br/> <a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for {{ port_name }} on Windows (PDF)</a><br/>
<span class="linkdescr">including DFU programming</span> <span class="linkdescr">including DFU programming</span>