From 4f23c5d58738cd443d43b8e01cbd2a90ae6a8c9d Mon Sep 17 00:00:00 2001 From: Paul Sokolovsky Date: Fri, 30 Jun 2017 22:24:01 +0300 Subject: [PATCH] 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. --- docs/pyboard/general.rst | 3 +++ docs/pyboard/hardware/index.rst | 6 +++--- docs/pyboard/tutorial/index.rst | 4 ++-- docs/pyboard_index.rst | 1 - docs/templates/topindex.html | 4 ---- 5 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/pyboard/general.rst b/docs/pyboard/general.rst index 1d040f6ccc..8cb801f4d6 100644 --- a/docs/pyboard/general.rst +++ b/docs/pyboard/general.rst @@ -1,6 +1,8 @@ General information about the pyboard ===================================== +.. contents:: + 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. This cannot be recovered from and you need to do a hard reset. +.. include:: hardware/index.rst diff --git a/docs/pyboard/hardware/index.rst b/docs/pyboard/hardware/index.rst index bc4726ce2d..91fea24e7a 100644 --- a/docs/pyboard/hardware/index.rst +++ b/docs/pyboard/hardware/index.rst @@ -1,7 +1,7 @@ .. _hardware_index: The pyboard hardware -==================== +-------------------- For the pyboard: @@ -16,14 +16,14 @@ For the official skin modules: * LCD160CRv1.0: see :mod:`lcd160cr` Datasheets for the components on the pyboard -============================================ +-------------------------------------------- * The microcontroller: `STM32F405RGT6 `_ (link to manufacturer's site) * The accelerometer: `Freescale MMA7660 `_ (800kiB PDF) * The LDO voltage regulator: `Microchip MCP1802 `_ (400kiB PDF) Datasheets for other components -=============================== +------------------------------- * The LCD display on the LCD touch-sensor skin: `Newhaven Display NHD-C12832A1Z-FSW-FBW-3V3 `_ (460KiB PDF) * The touch sensor chip on the LCD touch-sensor skin: `Freescale MPR121 `_ (280KiB PDF) diff --git a/docs/pyboard/tutorial/index.rst b/docs/pyboard/tutorial/index.rst index 07f136c9b4..1dc155f149 100644 --- a/docs/pyboard/tutorial/index.rst +++ b/docs/pyboard/tutorial/index.rst @@ -1,7 +1,7 @@ .. _tutorial-index: -MicroPython tutorial -==================== +MicroPython tutorial for the 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 diff --git a/docs/pyboard_index.rst b/docs/pyboard_index.rst index 9d8f783dec..2255a75607 100644 --- a/docs/pyboard_index.rst +++ b/docs/pyboard_index.rst @@ -6,7 +6,6 @@ MicroPython documentation and references pyboard/quickref.rst pyboard/general.rst pyboard/tutorial/index.rst - pyboard/hardware/index.rst library/index.rst reference/index.rst genrst/index.rst diff --git a/docs/templates/topindex.html b/docs/templates/topindex.html index 3a9269eb17..84f3a3aecf 100644 --- a/docs/templates/topindex.html +++ b/docs/templates/topindex.html @@ -58,10 +58,6 @@ information about MicroPython specific language features

{% if port == "pyboard" %} -

- The {{ port }} hardware
- schematics, dimensions and component datasheets -

Guide for {{ port_name }} on Windows (PDF)
including DFU programming