diff options
| author | Radomir Dopieralski <openstack@sheep.art.pl> | 2015-05-26 23:34:31 +0200 |
|---|---|---|
| committer | Damien George <damien.p.george@gmail.com> | 2015-05-30 12:49:58 +0100 |
| commit | 78ccb44a90584387dba6cfbdaa19fb651a6f64ab (patch) | |
| tree | b885ce8fba8a0bb63025cdc679e2e37cea23b289 /docs/library/index.rst | |
| parent | 278d22ce8f9c5b51778f70d36088a986f1b6adc8 (diff) | |
| download | micropython-78ccb44a90584387dba6cfbdaa19fb651a6f64ab.tar.gz micropython-78ccb44a90584387dba6cfbdaa19fb651a6f64ab.zip | |
docs: Document esp module for ESP8266.
I document as much as I could guess from experiments and reading the
code for the ``esp`` module for the ESP8266 port of Micropython.
For now the tag has to be set manually with -t option when building,
when we have properly split documentation, there will be a separate
config file for esp8266 with that the tag "port_esp8266" set.
To build use:
make SPHINXOPTS="-t port_esp8266" html
Diffstat (limited to 'docs/library/index.rst')
| -rw-r--r-- | docs/library/index.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/library/index.rst b/docs/library/index.rst index b5a7b3ca9c..9b77271814 100644 --- a/docs/library/index.rst +++ b/docs/library/index.rst @@ -65,3 +65,15 @@ The following libraries are specific to the pyboard. pyb.rst network.rst + +.. only:: port_esp8266 + + Libraries specific to the ESP8266 + --------------------------------- + + The following libraries are specific to the ESP8266. + + .. toctree:: + :maxdepth: 2 + + esp.rst |