2015-12-04 23:12:28 +01:00
|
|
|
site_name: NodeMCU Documentation
|
|
|
|
|
site_description: Description of the NodeMCU documentation
|
2015-12-05 01:05:14 +01:00
|
|
|
repo_url: https://github.com/nodemcu/nodemcu-firmware/
|
2015-12-14 21:41:06 +01:00
|
|
|
|
2015-12-17 17:33:43 +01:00
|
|
|
theme: readthedocs
|
2015-12-13 14:43:52 +01:00
|
|
|
strict: true
|
2015-12-17 17:33:43 +01:00
|
|
|
|
2015-12-05 01:05:14 +01:00
|
|
|
markdown_extensions:
|
2015-12-17 17:33:43 +01:00
|
|
|
#http://pythonhosted.org/Markdown/extensions/admonition.html
|
2015-12-14 21:41:06 +01:00
|
|
|
- admonition:
|
2015-12-05 01:05:14 +01:00
|
|
|
- toc:
|
|
|
|
|
permalink: True
|
2015-12-14 21:41:06 +01:00
|
|
|
|
2016-01-01 15:12:04 +01:00
|
|
|
#requird due to https://github.com/rtfd/readthedocs.org/issues/1313
|
2015-12-27 23:51:54 +01:00
|
|
|
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
|
2015-12-27 23:49:11 +01:00
|
|
|
extra_css:
|
|
|
|
|
- css/extra.css
|
2015-12-27 23:51:54 +01:00
|
|
|
extra_javascript:
|
2015-12-27 23:49:11 +01:00
|
|
|
- js/extra.js
|
|
|
|
|
|
|
|
|
|
site_favicon: img/favicon.png
|
|
|
|
|
|
2015-12-04 23:12:28 +01:00
|
|
|
pages:
|
2015-12-27 23:32:07 +01:00
|
|
|
- Overview: 'index.md'
|
|
|
|
|
- English:
|
2015-12-28 17:25:00 +01:00
|
|
|
- Building the firmware: 'en/build.md'
|
2017-03-24 23:51:13 +01:00
|
|
|
- Flashing the firmware: 'en/flash.md'
|
2017-04-15 17:38:20 +02:00
|
|
|
- Filesystem on SD card: 'en/sdcard.md'
|
2016-01-16 23:11:40 +01:00
|
|
|
- Uploading code: 'en/upload.md'
|
Add New Tasking I/F and rework GPIO, UART, etc to support it
As with the last commit this rolls up the follwowing, but include the various
review comments on the PR.
- **Documentation changes**. I've added the taks FAQ as a stub new Extension
developer FAQ, and split the old FAQ into a Lua Developer FAQ and a Hardware
FAQ.
- **Tasking I/F**. New `app/task/Makefile`, `app/task/task.c`,
`app/include/task/task.h` and `app/Makefile` as per previous commit. Cascade
changes to `app/driver/uart.c`, `app/include/driver/uart.h`,
`app/user/user_main.c` and `app/modules/node.c`
- **GPIO Rework** to `app/modules/gpio.c` and `pin_map.[hc]`, `platform.[hc]`
in `app/platform`
- **Other Optimisations** Move the `platform_*_exists()` from
`app/platform/common.c` to static inline declarations in `platform.h` as
this generates faster, smaller code. Move lgc.a routines out of iram0.
2016-02-17 18:13:17 +01:00
|
|
|
- FAQs:
|
|
|
|
|
- Lua Developer FAQ: 'en/lua-developer-faq.md'
|
|
|
|
|
- Extension Developer FAQ: 'en/extn-developer-faq.md'
|
2015-12-28 17:25:00 +01:00
|
|
|
- Support: 'en/support.md'
|
2015-12-27 23:32:07 +01:00
|
|
|
- Modules:
|
2017-05-26 21:39:29 +02:00
|
|
|
- 'adc': 'en/modules/adc.md'
|
|
|
|
|
- 'bit': 'en/modules/bit.md'
|
|
|
|
|
- 'bthci': 'en/modules/bthci.md'
|
|
|
|
|
- 'can': 'en/modules/can.md'
|
|
|
|
|
- 'dht': 'en/modules/dht.md'
|
|
|
|
|
- 'file': 'en/modules/file.md'
|
|
|
|
|
- 'gpio': 'en/modules/gpio.md'
|
|
|
|
|
- 'i2c': 'en/modules/i2c.md'
|
2017-07-25 22:23:34 +02:00
|
|
|
- 'net': 'en/modules/net.md'
|
2017-05-26 21:39:29 +02:00
|
|
|
- 'node': 'en/modules/node.md'
|
|
|
|
|
- 'ow (1-Wire)': 'en/modules/ow.md'
|
|
|
|
|
- 'sdmmc': 'en/modules/sdmmc.md'
|
|
|
|
|
- 'sigma delta': 'en/modules/sigma-delta.md'
|
|
|
|
|
- 'spi': 'en/modules/spi.md'
|
|
|
|
|
- 'struct': 'en/modules/struct.md'
|
|
|
|
|
- 'tmr': 'en/modules/tmr.md'
|
|
|
|
|
- 'u8g2': 'en/modules/u8g2.md'
|
|
|
|
|
- 'u8g2 Display': 'en/modules/u8g2_disp.md'
|
|
|
|
|
- 'uart': 'en/modules/uart.md'
|
|
|
|
|
- 'wifi': 'en/modules/wifi.md'
|
|
|
|
|
- 'ws2812': 'en/modules/ws2812.md'
|
2016-11-17 11:56:51 +01:00
|
|
|
|
