Commit b126c6b2 authored by Marcel Stör's avatar Marcel Stör
Browse files

Re-organize documentation

Drop support for localized content, #2213

Restructure some content to match more closely what we have in master, #2542
parent 87b3ffa6
# HTTP Server Module # HTTP Server Module
Documentation for this Lua module is available in the [http.md](../../docs/en/lua-modules/http.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section. Documentation for this Lua module is available in the [httpserver.md](../../docs/lua-modules/httpserver.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section.
\ No newline at end of file
# HTTP Server Module # HTTP Server Module
Documentation for this Lua module is available in the [lm92.md](../../docs/en/lua-modules/lm92.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section. Documentation for this Lua module is available in the [lm92.md](../../docs/lua-modules/lm92.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section.
\ No newline at end of file
# MCP23008 Module # MCP23008 Module
Documentation for this Lua module is available in the [mcp23008.md](../../docs/en/lua-modules/mcp23008.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section. Documentation for this Lua module is available in the [mcp23008.md](../../docs/lua-modules/mcp23008.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section.
\ No newline at end of file
# Redis Module # Redis Module
Documentation for this Lua module is available in the [redis.md](../../docs/en/lua-modules/redis.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section. Documentation for this Lua module is available in the [redis.md](../../docs/lua-modules/redis.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section.
\ No newline at end of file
# Yeelink Module # Yeelink Module
Documentation for this Lua module is available in the [yeelink.md](../../docs/en/lua-modules/yeelink.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section. Documentation for this Lua module is available in the [yeelink.md](../../docs/lua-modules/yeelink.md) file and in the [Official NodeMCU Documentation](https://nodemcu.readthedocs.io/) in `Lua Modules` section.
\ No newline at end of file
...@@ -4,7 +4,7 @@ repo_url: https://github.com/nodemcu/nodemcu-firmware/ ...@@ -4,7 +4,7 @@ repo_url: https://github.com/nodemcu/nodemcu-firmware/
theme: theme:
name: "readthedocs" name: "readthedocs"
strict: false #Allows to build and test documentation in local enviroment where some links are unreachable strict: false #Allows to build and test documentation in local environment where some links are unreachable
markdown_extensions: markdown_extensions:
#http://pythonhosted.org/Markdown/extensions/admonition.html #http://pythonhosted.org/Markdown/extensions/admonition.html
...@@ -22,99 +22,99 @@ extra_javascript: ...@@ -22,99 +22,99 @@ extra_javascript:
pages: pages:
- Overview: 'index.md' - Overview: 'index.md'
- Basics: - Basics:
- Getting started: 'en/getting-started.md' - Getting started: 'getting-started.md'
- Building the firmware: 'en/build.md' - Building the firmware: 'build.md'
- Flashing the firmware: 'en/flash.md' - Flashing the firmware: 'flash.md'
- Uploading code: 'en/upload.md' - Uploading code: 'upload.md'
- Compiling code: 'en/compiling.md' - Compiling code: 'compiling.md'
- Support: 'en/support.md' - Support: 'support.md'
- FAQs: - FAQs:
- Lua Developer FAQ: 'en/lua-developer-faq.md' - Lua Developer FAQ: 'lua-developer-faq.md'
- Extension Developer FAQ: 'en/extn-developer-faq.md' - Extension Developer FAQ: 'extn-developer-faq.md'
- Hardware FAQ: 'en/hardware-faq.md' - Hardware FAQ: 'hardware-faq.md'
- Whitepapers: - Whitepapers:
- Filesystem on SD card: 'en/sdcard.md' - Filesystem on SD card: 'sdcard.md'
- Internal filesystem: 'en/spiffs.md' - Internal filesystem: 'spiffs.md'
- Lua Compact Debug (LCD): 'en/lcd.md' - Lua Compact Debug (LCD): 'lcd.md'
- Lua Flash Store (LFS): 'en/lfs.md' - Lua Flash Store (LFS): 'lfs.md'
- Lua Modules: - Lua Modules:
- 'bh1750': 'en/lua-modules/bh1750.md' - 'bh1750': 'lua-modules/bh1750.md'
- 'ds18b20': 'en/lua-modules/ds18b20.md' - 'ds18b20': 'lua-modules/ds18b20.md'
- 'ds3231': 'en/lua-modules/ds3231.md' - 'ds3231': 'lua-modules/ds3231.md'
- 'ftpserver': 'en/lua-modules/ftpserver.md' - 'ftpserver': 'lua-modules/ftpserver.md'
- 'hdc1000': 'en/lua-modules/hdc1000.md' - 'hdc1000': 'lua-modules/hdc1000.md'
- 'httpserver': 'en/lua-modules/httpserver.md' - 'httpserver': 'lua-modules/httpserver.md'
- 'imap': 'en/lua-modules/imap.md' - 'imap': 'lua-modules/imap.md'
- 'lm92': 'en/lua-modules/lm92.md' - 'lm92': 'lua-modules/lm92.md'
- 'mcp23008': 'en/lua-modules/mcp23008.md' - 'mcp23008': 'lua-modules/mcp23008.md'
- 'redis': 'en/lua-modules/redis.md' - 'redis': 'lua-modules/redis.md'
- 'yeelink': 'en/lua-modules/yeelink.md' - 'yeelink': 'lua-modules/yeelink.md'
- C Modules: - C Modules:
- 'adc': 'en/modules/adc.md' - 'adc': 'modules/adc.md'
- 'ads1115': 'en/modules/ads1115.md' - 'ads1115': 'modules/ads1115.md'
- 'adxl345' : 'en/modules/adxl345.md' - 'adxl345' : 'modules/adxl345.md'
- 'am2320': 'en/modules/am2320.md' - 'am2320': 'modules/am2320.md'
- 'apa102': 'en/modules/apa102.md' - 'apa102': 'modules/apa102.md'
- 'bit': 'en/modules/bit.md' - 'bit': 'modules/bit.md'
- 'bloom' : 'en/modules/bloom.md' - 'bloom' : 'modules/bloom.md'
- 'bme280': 'en/modules/bme280.md' - 'bme280': 'modules/bme280.md'
- 'bme680': 'en/modules/bme680.md' - 'bme680': 'modules/bme680.md'
- 'bmp085': 'en/modules/bmp085.md' - 'bmp085': 'modules/bmp085.md'
- 'cjson': 'en/modules/cjson.md' - 'cjson': 'modules/cjson.md'
- 'coap': 'en/modules/coap.md' - 'coap': 'modules/coap.md'
- 'color-utils': 'en/modules/color-utils.md' - 'color-utils': 'modules/color-utils.md'
- 'cron': 'en/modules/cron.md' - 'cron': 'modules/cron.md'
- 'crypto': 'en/modules/crypto.md' - 'crypto': 'modules/crypto.md'
- 'dht': 'en/modules/dht.md' - 'dht': 'modules/dht.md'
- 'ds18b20': 'en/modules/ds18b20.md' - 'ds18b20': 'modules/ds18b20.md'
- 'encoder': 'en/modules/encoder.md' - 'encoder': 'modules/encoder.md'
- 'enduser setup': 'en/modules/enduser-setup.md' - 'enduser setup': 'modules/enduser-setup.md'
- 'file': 'en/modules/file.md' - 'file': 'modules/file.md'
- 'gdbstub': 'en/modules/gdbstub.md' - 'gdbstub': 'modules/gdbstub.md'
- 'gpio': 'en/modules/gpio.md' - 'gpio': 'modules/gpio.md'
- 'hdc1080': 'en/modules/hdc1080.md' - 'hdc1080': 'modules/hdc1080.md'
- 'hmc5883l': 'en/modules/hmc5883l.md' - 'hmc5883l': 'modules/hmc5883l.md'
- 'http': 'en/modules/http.md' - 'http': 'modules/http.md'
- 'hx711' : 'en/modules/hx711.md' - 'hx711' : 'modules/hx711.md'
- 'i2c' : 'en/modules/i2c.md' - 'i2c' : 'modules/i2c.md'
- 'l3g4200d' : 'en/modules/l3g4200d.md' - 'l3g4200d' : 'modules/l3g4200d.md'
- 'mcp4725': 'en/modules/mcp4725.md' - 'mcp4725': 'modules/mcp4725.md'
- 'mdns': 'en/modules/mdns.md' - 'mdns': 'modules/mdns.md'
- 'mqtt': 'en/modules/mqtt.md' - 'mqtt': 'modules/mqtt.md'
- 'net': 'en/modules/net.md' - 'net': 'modules/net.md'
- 'node': 'en/modules/node.md' - 'node': 'modules/node.md'
- 'ow (1-Wire)': 'en/modules/ow.md' - 'ow (1-Wire)': 'modules/ow.md'
- 'pcm' : 'en/modules/pcm.md' - 'pcm' : 'modules/pcm.md'
- 'perf': 'en/modules/perf.md' - 'perf': 'modules/perf.md'
- 'pwm' : 'en/modules/pwm.md' - 'pwm' : 'modules/pwm.md'
- 'rc' : 'en/modules/rc.md' - 'rc' : 'modules/rc.md'
- 'rfswitch' : 'en/modules/rfswitch.md' - 'rfswitch' : 'modules/rfswitch.md'
- 'rotary' : 'en/modules/rotary.md' - 'rotary' : 'modules/rotary.md'
- 'rtcfifo': 'en/modules/rtcfifo.md' - 'rtcfifo': 'modules/rtcfifo.md'
- 'rtcmem': 'en/modules/rtcmem.md' - 'rtcmem': 'modules/rtcmem.md'
- 'rtctime': 'en/modules/rtctime.md' - 'rtctime': 'modules/rtctime.md'
- 'si7021' : 'en/modules/si7021.md' - 'si7021' : 'modules/si7021.md'
- 'sigma delta': 'en/modules/sigma-delta.md' - 'sigma delta': 'modules/sigma-delta.md'
- 'sjson': 'en/modules/sjson.md' - 'sjson': 'modules/sjson.md'
- 'sntp': 'en/modules/sntp.md' - 'sntp': 'modules/sntp.md'
- 'somfy': 'en/modules/somfy.md' - 'somfy': 'modules/somfy.md'
- 'spi': 'en/modules/spi.md' - 'spi': 'modules/spi.md'
- 'sqlite3': 'en/modules/sqlite3.md' - 'sqlite3': 'modules/sqlite3.md'
- 'struct': 'en/modules/struct.md' - 'struct': 'modules/struct.md'
- 'switec': 'en/modules/switec.md' - 'switec': 'modules/switec.md'
- 'tcs34725': 'en/modules/tcs34725.md' - 'tcs34725': 'modules/tcs34725.md'
- 'tls': 'en/modules/tls.md' - 'tls': 'modules/tls.md'
- 'tm1829': 'en/modules/tm1829.md' - 'tm1829': 'modules/tm1829.md'
- 'tmr': 'en/modules/tmr.md' - 'tmr': 'modules/tmr.md'
- 'tsl2561': 'en/modules/tsl2561.md' - 'tsl2561': 'modules/tsl2561.md'
- 'u8g2': 'en/modules/u8g2.md' - 'u8g2': 'modules/u8g2.md'
- 'uart': 'en/modules/uart.md' - 'uart': 'modules/uart.md'
- 'ucg': 'en/modules/ucg.md' - 'ucg': 'modules/ucg.md'
- 'websocket': 'en/modules/websocket.md' - 'websocket': 'modules/websocket.md'
- 'wifi': 'en/modules/wifi.md' - 'wifi': 'modules/wifi.md'
- 'wifi.monitor': 'en/modules/wifi_monitor.md' - 'wifi.monitor': 'modules/wifi_monitor.md'
- 'wps': 'en/modules/wps.md' - 'wps': 'modules/wps.md'
- 'ws2801': 'en/modules/ws2801.md' - 'ws2801': 'modules/ws2801.md'
- 'ws2812': 'en/modules/ws2812.md' - 'ws2812': 'modules/ws2812.md'
- 'ws2812-effects': 'en/modules/ws2812-effects.md' - 'ws2812-effects': 'modules/ws2812-effects.md'
- 'xpt2046': 'en/modules/xpt2046.md' - 'xpt2046': 'modules/xpt2046.md'
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment