Commit f5fcd0d9 authored by galjonsfigur's avatar galjonsfigur Committed by Arnim Läuger
Browse files

Recreate and unify documentation for Lua modules (#2592)

* Recreate and unify documentation for Lua modules

* Fix typos in docs

* Added/modified READMES to link to new documentation
parent 0a500eb9
# 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.
\ No newline at end of file
# 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.
\ 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: true strict: false #Allows to build and test documentation in local enviroment where some links are unreachable
markdown_extensions: markdown_extensions:
#http://pythonhosted.org/Markdown/extensions/admonition.html #http://pythonhosted.org/Markdown/extensions/admonition.html
...@@ -12,7 +12,7 @@ markdown_extensions: ...@@ -12,7 +12,7 @@ markdown_extensions:
- toc: - toc:
permalink: True permalink: True
#requird due to https://github.com/rtfd/readthedocs.org/issues/1313 #required due to https://github.com/rtfd/readthedocs.org/issues/1313
#see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme #see http://mkdocs.readthedocs.org/en/latest/user-guide/styling-your-docs/#customising-a-theme
extra_css: extra_css:
- css/extra.css - css/extra.css
...@@ -37,10 +37,21 @@ pages: ...@@ -37,10 +37,21 @@ pages:
- Internal filesystem: 'en/spiffs.md' - Internal filesystem: 'en/spiffs.md'
- Lua Compact Debug (LCD): 'en/lcd.md' - Lua Compact Debug (LCD): 'en/lcd.md'
- Lua Flash Store (LFS): 'en/lfs.md' - Lua Flash Store (LFS): 'en/lfs.md'
- Modules: - Lua Modules:
- 'bh1750': 'en/lua-modules/bh1750.md'
- 'ds18b20': 'en/lua-modules/ds18b20.md'
- 'ds3231': 'en/lua-modules/ds3231.md'
- 'ftpserver': 'en/lua-modules/ftpserver.md'
- 'hdc1000': 'en/lua-modules/hdc1000.md'
- 'imap': 'en/lua-modules/imap.md'
- 'lm92': 'en/lua-modules/lm92.md'
- 'mcp23008': 'en/lua-modules/mcp23008.md'
- 'redis': 'en/lua-modules/redis.md'
- 'yeelink': 'en/lua-modules/yeelink.md'
- C Modules:
- 'adc': 'en/modules/adc.md' - 'adc': 'en/modules/adc.md'
- 'ads1115' : 'en/modules/ads1115.md' - 'ads1115': 'en/modules/ads1115.md'
- 'adxl345': 'en/modules/adxl345.md' - 'adxl345' : 'en/modules/adxl345.md'
- 'am2320': 'en/modules/am2320.md' - 'am2320': 'en/modules/am2320.md'
- 'apa102': 'en/modules/apa102.md' - 'apa102': 'en/modules/apa102.md'
- 'bit': 'en/modules/bit.md' - 'bit': 'en/modules/bit.md'
...@@ -105,4 +116,4 @@ pages: ...@@ -105,4 +116,4 @@ pages:
- 'ws2801': 'en/modules/ws2801.md' - 'ws2801': 'en/modules/ws2801.md'
- 'ws2812': 'en/modules/ws2812.md' - 'ws2812': 'en/modules/ws2812.md'
- 'ws2812-effects': 'en/modules/ws2812-effects.md' - 'ws2812-effects': 'en/modules/ws2812-effects.md'
- 'xpt2046': 'en/modules/xpt2046.md' - 'xpt2046': 'en/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