docs: Unify all the ports into one set of documentation.
With this commit there is now only one entry point into the whole documentation, which describes the general MicroPython language, and then from there there are links to information about specific platforms/ports. This commit doesn't change content (almost, it does fix a few internal links), it just reorganises things.
This commit is contained in:
@@ -1,3 +1,5 @@
|
||||
.. _pyboard_general:
|
||||
|
||||
General information about the pyboard
|
||||
=====================================
|
||||
|
||||
@@ -77,4 +79,6 @@ including setting up the serial prompt and downloading new firmware using
|
||||
DFU programming:
|
||||
`PDF guide <http://micropython.org/resources/Micro-Python-Windows-setup.pdf>`__.
|
||||
|
||||
.. _hardware_index:
|
||||
|
||||
.. include:: hardware/index.rst
|
||||
|
||||
@@ -1,5 +1,3 @@
|
||||
.. _hardware_index:
|
||||
|
||||
The pyboard hardware
|
||||
--------------------
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _quickref:
|
||||
.. _pyboard_quickref:
|
||||
|
||||
Quick reference for the pyboard
|
||||
===============================
|
||||
@@ -20,6 +20,15 @@ or `PYBLITEv1.0 <http://micropython.org/resources/pyblitev10-pinout.jpg>`__.
|
||||
.. image:: http://micropython.org/resources/pybv10-pinout-800px.jpg
|
||||
:alt: PYBv1.0 pinout
|
||||
|
||||
Below is a quick reference for the pyboard. If it is your first time working with
|
||||
this board please consider reading the following sections first:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
general.rst
|
||||
tutorial/index.rst
|
||||
|
||||
General board control
|
||||
---------------------
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ For this tutorial, we will use the ``X1`` pin. Connect one end of the resistor t
|
||||
|
||||
Code
|
||||
----
|
||||
By examining the :ref:`quickref`, we see that ``X1`` is connected to channel 1 of timer 5 (``TIM5 CH1``). Therefore we will first create a ``Timer`` object for timer 5, then create a ``TimerChannel`` object for channel 1::
|
||||
By examining the :ref:`pyboard_quickref`, we see that ``X1`` is connected to channel 1 of timer 5 (``TIM5 CH1``). Therefore we will first create a ``Timer`` object for timer 5, then create a ``TimerChannel`` object for channel 1::
|
||||
|
||||
from pyb import Timer
|
||||
from time import sleep
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
.. _tutorial-index:
|
||||
.. _pyboard_tutorial:
|
||||
|
||||
MicroPython tutorial for the pyboard
|
||||
====================================
|
||||
|
||||
Reference in New Issue
Block a user