Skip to content

Commit 4f23c5d

Browse files
pfalconpfalcon
committed
docs/pyboard: Move hardware info into General Info chapter.
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.
1 parent e467949 commit 4f23c5d

5 files changed

Lines changed: 8 additions & 10 deletions

File tree

‎docs/pyboard/general.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
General information about the pyboard
22
=====================================
33

4+
.. contents::
5+
46
Local filesystem and SD card
57
----------------------------
68

@@ -67,3 +69,4 @@ There are currently 2 kinds of errors that you might see:
6769
2. If all 4 LEDs cycle on and off slowly, then there was a hard fault.
6870
This cannot be recovered from and you need to do a hard reset.
6971

72+
.. include:: hardware/index.rst

‎docs/pyboard/hardware/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _hardware_index:
22

33
The pyboard hardware
4-
====================
4+
--------------------
55

66
For the pyboard:
77

@@ -16,14 +16,14 @@ For the official skin modules:
1616
* LCD160CRv1.0: see :mod:`lcd160cr`
1717

1818
Datasheets for the components on the pyboard
19-
============================================
19+
--------------------------------------------
2020

2121
* The microcontroller: `STM32F405RGT6 <http://www.st.com/web/catalog/mmc/FM141/SC1169/SS1577/LN1035/PF252144>`_ (link to manufacturer's site)
2222
* The accelerometer: `Freescale MMA7660 <http://micropython.org/resources/datasheets/MMA7660FC.pdf>`_ (800kiB PDF)
2323
* The LDO voltage regulator: `Microchip MCP1802 <http://micropython.org/resources/datasheets/MCP1802-22053C.pdf>`_ (400kiB PDF)
2424

2525
Datasheets for other components
26-
===============================
26+
-------------------------------
2727

2828
* 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)
2929
* The touch sensor chip on the LCD touch-sensor skin: `Freescale MPR121 <http://micropython.org/resources/datasheets/MPR121.pdf>`_ (280KiB PDF)

‎docs/pyboard/tutorial/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _tutorial-index:
22

3-
MicroPython tutorial
4-
====================
3+
MicroPython tutorial for the pyboard
4+
====================================
55

66
This tutorial is intended to get you started with your pyboard.
77
All you need is a pyboard and a micro-USB cable to connect it to

‎docs/pyboard_index.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ MicroPython documentation and references
66
pyboard/quickref.rst
77
pyboard/general.rst
88
pyboard/tutorial/index.rst
9-
pyboard/hardware/index.rst
109
library/index.rst
1110
reference/index.rst
1211
genrst/index.rst

‎docs/templates/topindex.html‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,10 +58,6 @@ <h1>MicroPython documentation</h1>
5858
<span class="linkdescr">information about MicroPython specific language features</span>
5959
</p>
6060
{% if port == "pyboard" %}
61-
<p class="biglink">
62-
<a class="biglink" href="{{ pathto(port + "/hardware/index") }}">The {{ port }} hardware</a><br/>
63-
<span class="linkdescr">schematics, dimensions and component datasheets</span>
64-
</p>
6561
<p class="biglink">
6662
<a class="biglink" href="http://micropython.org/resources/Micro-Python-Windows-setup.pdf">Guide for {{ port_name }} on Windows (PDF)</a><br/>
6763
<span class="linkdescr">including DFU programming</span>

0 commit comments

Comments
 (0)