From e8ee825c25e82057c4e8be54f8e1f5c9cae66136 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcel=20St=C3=B6r?= Date: Thu, 28 Apr 2016 08:09:35 +0200 Subject: [PATCH] Switch from readthedocs.org to readthedocs.io --- CONTRIBUTING.md | 2 +- README.md | 17 +++++++++-------- docs/js/extra.js | 4 ++-- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d2778d1..030e94ac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,7 @@ Use the platform and tools you feel most comfortable with. There are no constra ## Writing Documentation The NodeMCU documentation is maintained within the same repository as the code. The primary reason is to keep the two in sync more easily. It's thus trivial for the NodeMCU team to verify that a PR includes the necessary documentation. Furthermore, the documentation is merged automatically with the code if it moves from branch X to Y. -The documentation consists of a collection of Markdown files (see note on Markdown syntax at end of chapter) stored in the [`/docs`](docs) directory. With every commit a human readable and browsable version is automatically built with [Read the Docs](https://readthedocs.org/) (RTD). The public NodeMCU documentation can be found at [nodemcu.readthedocs.org](http://nodemcu.readthedocs.org/). +The documentation consists of a collection of Markdown files (see note on Markdown syntax at end of chapter) stored in the [`/docs`](docs) directory. With every commit a human readable and browsable version is automatically built with [Read the Docs](https://readthedocs.io/) (RTD). The public NodeMCU documentation can be found at [nodemcu.readthedocs.io](http://nodemcu.readthedocs.io/). There are essentially only two things to keep in mind if you're contributing a PR: diff --git a/README.md b/README.md index 31015c24..65ef6b81 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Join the chat at https://gitter.im/nodemcu/nodemcu-firmware](https://img.shields.io/gitter/room/badges/shields.svg)](https://gitter.im/nodemcu/nodemcu-firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/nodemcu/nodemcu-firmware.svg)](https://travis-ci.org/nodemcu/nodemcu-firmware) -[![Documentation Status](https://readthedocs.org/projects/nodemcu/badge/?version=dev)](http://nodemcu.readthedocs.org/) +[![Documentation Status](https://readthedocs.io/projects/nodemcu/badge/?version=dev)](http://nodemcu.readthedocs.io/) [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/nodemcu/nodemcu-firmware/blob/master/LICENSE) ### A Lua based firmware for ESP8266 WiFi SOC @@ -18,7 +18,7 @@ The NodeMCU *firmware* is a companion project to the popular [NodeMCU dev kits]( - Asynchronous event-driven programming model - 40+ built-in modules - Firmware available with or without floating point support (integer-only uses less memory) -- Up-to-date documentation at [https://nodemcu.readthedocs.org](https://nodemcu.readthedocs.org) +- Up-to-date documentation at [https://nodemcu.readthedocs.io](https://nodemcu.readthedocs.io) # Programming Model @@ -43,16 +43,16 @@ wifi.sta.config("SSID", "password") # Documentation -The entire [NodeMCU documentation](https://nodemcu.readthedocs.org) is maintained right in this repository at [/docs](docs). The fact that the API documentation is mainted in the same repository as the code that *provides* the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at [https://nodemcu.readthedocs.org](https://nodemcu.readthedocs.org). +The entire [NodeMCU documentation](https://nodemcu.readthedocs.io) is maintained right in this repository at [/docs](docs). The fact that the API documentation is mainted in the same repository as the code that *provides* the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at [https://nodemcu.readthedocs.io](https://nodemcu.readthedocs.io). -- How to [build the firmware](https://nodemcu.readthedocs.org/en/dev/en/build/) -- How to [flash the firmware](https://nodemcu.readthedocs.org/en/dev/en/flash/) -- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.org/en/dev/en/upload/) +- How to [build the firmware](https://nodemcu.readthedocs.io/en/dev/en/build/) +- How to [flash the firmware](https://nodemcu.readthedocs.io/en/dev/en/flash/) +- How to [upload code and NodeMCU IDEs](https://nodemcu.readthedocs.io/en/dev/en/upload/) - API documentation for every module # Support -See [https://nodemcu.readthedocs.org/en/dev/en/support/](https://nodemcu.readthedocs.org/en/dev/en/support/). +See [https://nodemcu.readthedocs.io/en/dev/en/support/](https://nodemcu.readthedocs.io/en/dev/en/support/). # License @@ -60,7 +60,7 @@ See [https://nodemcu.readthedocs.org/en/dev/en/support/](https://nodemcu.readthe # Build Options -The following sections explain some of the options you have if you want to [build your own NodeMCU firmware](http://nodemcu.readthedocs.org/en/dev/en/build/). +The following sections explain some of the options you have if you want to [build your own NodeMCU firmware](http://nodemcu.readthedocs.io/en/dev/en/build/). ### Select Modules @@ -106,3 +106,4 @@ To enable runtime debug messages to serial console edit `app/include/user_config ```c #define DEVELOP_VERSION ``` +readthedocs.io \ No newline at end of file diff --git a/docs/js/extra.js b/docs/js/extra.js index 01349c91..7c00bfad 100644 --- a/docs/js/extra.js +++ b/docs/js/extra.js @@ -66,9 +66,9 @@ var nodemcu = nodemcu || {}; * *
*
Languages
- *
de
+ *
de
* - *
en
+ *
en
* *
*