diff options
Diffstat (limited to 'docs/tutorial')
| -rw-r--r-- | docs/tutorial/amp_skin.rst | 6 | ||||
| -rw-r--r-- | docs/tutorial/index.rst | 18 | ||||
| -rw-r--r-- | docs/tutorial/lcd_skin.rst | 4 | ||||
| -rw-r--r-- | docs/tutorial/repl.rst | 2 | ||||
| -rw-r--r-- | docs/tutorial/script.rst | 8 |
5 files changed, 19 insertions, 19 deletions
diff --git a/docs/tutorial/amp_skin.rst b/docs/tutorial/amp_skin.rst index 66513a5b2a..fbf0bde2d3 100644 --- a/docs/tutorial/amp_skin.rst +++ b/docs/tutorial/amp_skin.rst @@ -51,11 +51,11 @@ For example:: dac.write_timed(buf, 400 * len(buf), mode=DAC.CIRCULAR) You can also play WAV files using the Python ``wave`` module. You can get -the wave module [here](/static/doc/examples/wave.py) and you will also need -the chunk module available [here](/static/doc/examples/chunk.py). Put these +the wave module `here <http://micropython.org/static/doc/examples/wave.py>`_ and you will also need +the chunk module available `here <http://micropython.org/static/doc/examples/chunk.py>`_. Put these on your pyboard (either on the flash or the SD card in the top-level directory). You will need an 8-bit WAV file to play, such as -[this one](/static/doc/examples/test.wav). Then you can do:: +`this one <http://micropython.org/static/doc/examples/test.wav>`_. Then you can do:: >>> import wave >>> from pyb import DAC diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index 19e48b5cad..ed1137e1be 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -24,15 +24,6 @@ the tutorial through in the order below. assembler.rst power_ctrl.rst -Tips, tricks and useful things to know --------------------------------------- - -.. toctree:: - :maxdepth: 1 - :numbered: - - pass_through.rst - Tutorials requiring extra components ------------------------------------ @@ -44,3 +35,12 @@ Tutorials requiring extra components fading_led.rst lcd_skin.rst amp_skin.rst + +Tips, tricks and useful things to know +-------------------------------------- + +.. toctree:: + :maxdepth: 1 + :numbered: + + pass_through.rst diff --git a/docs/tutorial/lcd_skin.rst b/docs/tutorial/lcd_skin.rst index 997c1c6f46..288b63162a 100644 --- a/docs/tutorial/lcd_skin.rst +++ b/docs/tutorial/lcd_skin.rst @@ -58,7 +58,7 @@ enables the 4 touch sensors. The third line reads the touch status and the ``touch`` variable holds the state of the 4 touch buttons (A, B, X, Y). -There is a simple driver [here](/static/doc/examples/mpr121.py) +There is a simple driver `here <http://micropython.org/static/doc/examples/mpr121.py>`_ which allows you to set the threshold and debounce parameters, and easily read the touch status and electrode voltage levels. Copy this script to your pyboard (either flash or SD card, in the top @@ -81,4 +81,4 @@ initialise the I2C bus using:: >>> m = mpr121.MPR121(pyb.I2C(2, pyb.I2C.MASTER)) There is also a demo which uses the LCD and the touch sensors together, -and can be found [here](/static/doc/examples/lcddemo.py). +and can be found `here <http://micropython.org/static/doc/examples/lcddemo.py>`_. diff --git a/docs/tutorial/repl.rst b/docs/tutorial/repl.rst index 345a0893ee..7874eeff2f 100644 --- a/docs/tutorial/repl.rst +++ b/docs/tutorial/repl.rst @@ -26,7 +26,7 @@ and see which COM port it is (eg COM4). You now need to run your terminal program. You can use HyperTerminal if you have it installed, or download the free program PuTTY: -[`putty.exe`](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html). +`putty.exe <http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html>`_. Using your serial program you must connect to the COM port that you found in the previous step. With PuTTY, click on "Session" in the left-hand panel, then click the "Serial" radio button on the right, then enter you COM port (eg COM4) in the diff --git a/docs/tutorial/script.rst b/docs/tutorial/script.rst index 5f70b72507..d1b12ae6d1 100644 --- a/docs/tutorial/script.rst +++ b/docs/tutorial/script.rst @@ -46,16 +46,16 @@ a window (or command line) should be showing the files on the pyboard drive. The drive you are looking at is known as ``/flash`` by the pyboard, and should contain the following 4 files: - - [``boot.py``](/static/doc/fresh-pyboard/boot.py) -- this script is executed when the pyboard boots up. It sets +* `boot.py <http://micropython.org/static/doc/fresh-pyboard/boot.py>`_ -- this script is executed when the pyboard boots up. It sets up various configuration options for the pyboard. - - [``main.py``](/static/doc/fresh-pyboard/main.py) -- this is the main script that will contain your Python program. +* `main.py <http://micropython.org/static/doc/fresh-pyboard/main.py>`_ -- this is the main script that will contain your Python program. It is executed after ``boot.py``. - - [``README.txt``](/static/doc/fresh-pyboard/README.txt) -- this contains some very basic information about getting +* `README.txt <http://micropython.org/static/doc/fresh-pyboard/README.txt>`_ -- this contains some very basic information about getting started with the pyboard. - - [``pybcdc.inf``](/static/doc/fresh-pyboard/pybcdc.inf) -- this is a Windows driver file to configure the serial USB +* `pybcdc.inf <http://micropython.org/static/doc/fresh-pyboard/pybcdc.inf>`_ -- this is a Windows driver file to configure the serial USB device. More about this in the next tutorial. Editing ``main.py`` |