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:
Damien George
2018-09-27 17:27:57 +10:00
parent 5cc9517fc5
commit b3e013f60e
19 changed files with 84 additions and 135 deletions

View File

@@ -1,3 +1,5 @@
.. _wipy_general:
General information about the WiPy
==================================

View File

@@ -1,4 +1,4 @@
.. _quickref_:
.. _wipy_quickref:
Quick reference for the WiPy
============================
@@ -7,6 +7,15 @@ Quick reference for the WiPy
:alt: WiPy pinout and alternate functions table
:width: 800px
Below is a quick reference for CC3200/WiPy. 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 (including sleep modes)
---------------------------------------------

View File

@@ -1,4 +1,4 @@
.. _wipy_tutorial_index:
.. _wipy_tutorial:
WiPy tutorials and examples
===========================

View File

@@ -23,7 +23,7 @@ As long as you take care of the hardware, you should be okay. It's almost
impossible to break the software on the WiPy, so feel free to play around
with writing code as much as you like. If the filesystem gets corrupt, see
below on how to reset it. In the worst case you might need to do a safe boot,
which is explained in detail :ref:`here <wipy_boot_modes>`.
which is explained in detail in :ref:`wipy_boot_modes`.
Plugging into the expansion board and powering on
-------------------------------------------------
@@ -32,13 +32,13 @@ The expansion board can power the WiPy via USB. The WiPy comes with a sticker
on top of the RF shield that labels all pins, and this should match the label
numbers on the expansion board headers. When plugging it in, the WiPy antenna
will end up on top of the SD card connector of the expansion board. A video
showing how to do this can be found `here <https://www.youtube.com/watch?v=47D9MZ9zFQw>`_.
showing how to do this can be found `here on YouTube <https://www.youtube.com/watch?v=47D9MZ9zFQw>`_.
Expansion board hardware guide
------------------------------
The document explaining the hardware details of the expansion board can be found
`here <https://github.com/wipy/wipy/blob/master/docs/User_manual_exp_board.pdf>`_.
`in this PDF <https://github.com/wipy/wipy/blob/master/docs/User_manual_exp_board.pdf>`_.
Powering by an external power source
------------------------------------