Add script for dynamically generating RST documents. Update platforms and frameworks documentation // Resolve 114

platformio/builder/scripts/frameworks/arduino.py

@@ -2,7 +2,11 @@
 # See LICENSE for details.
 
 """
-    Build script for Arduino Framework (based on Wiring).
+Arduino Framework allows writing cross-platform software to control
+devices attached to a wide range of Arduino boards to create all
+kinds of creative coding, interactive objects, spaces or physical experiences.
+
+http://arduino.cc/en/Reference/HomePage
 """
 
 from os import listdir, walk
@@ -146,7 +150,6 @@ if BOARD_BUILDOPTS.get("core", None) == "teensy":
 # Target: Build Core Library
 #
 
-
 libs = []
 
 if "variant" in BOARD_BUILDOPTS:

platformio/builder/scripts/frameworks/cmsis.py

@@ -2,7 +2,15 @@
 # See LICENSE for details.
 
 """
-    Build script for CMSIS Framework.
+The ARM Cortex Microcontroller Software Interface Standard (CMSIS) is a
+vendor-independent hardware abstraction layer for the Cortex-M processor
+series and specifies debugger interfaces. The CMSIS enables consistent and
+simple software interfaces to the processor for interface peripherals,
+real-time operating systems, and middleware. It simplifies software
+re-use, reducing the learning curve for new microcontroller developers
+and cutting the time-to-market for devices.
+
+http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php
 """
 
 from os.path import join

platformio/builder/scripts/frameworks/energia.py

@@ -2,7 +2,13 @@
 # See LICENSE for details.
 
 """
-    Build script for Energia Framework (based on Wiring).
+Energia framework enables pretty much anyone to start easily creating
+microcontroller-based projects and applications. Its easy-to-use libraries
+and functions provide developers of all experience levels to start
+blinking LEDs, buzzing buzzers and sensing sensors more quickly than ever
+before.
+
+http://energia.nu/reference/
 """
 
 from os.path import join

platformio/builder/scripts/frameworks/mbed.py

@@ -2,7 +2,15 @@
 # See LICENSE for details.
 
 """
-    Build script for Mbed Framework
+The mbed framework The mbed SDK has been designed to provide enough
+hardware abstraction to be intuitive and concise, yet powerful enough to
+build complex projects. It is built on the low-level ARM CMSIS APIs,
+allowing you to code down to the metal if needed. In addition to RTOS,
+USB and Networking libraries, a cookbook of hundreds of reusable
+peripheral and module libraries have been built on top of the SDK by
+the mbed Developer Community.
+
+http://mbed.org/
 """
 
 import xml.etree.ElementTree as ElementTree
@@ -123,17 +131,17 @@ for lib_path in eixdata.get("CPPPATH"):
 
 
 #
-# Target: Build MBED Library
+# Target: Build mbed Library
 #
 
 libs = [l for l in eixdata.get("STDLIBS", []) if l not in env.get("LIBS")]
 
 env.VariantDir(
-    join("$BUILD_DIR", "FrameworkMBED"),
+    join("$BUILD_DIR", "FrameworkMbed"),
     join("$PLATFORMFW_DIR", "core")
 )
 libs.append(env.Library(
-    join("$BUILD_DIR", "FrameworkMBED"),
+    join("$BUILD_DIR", "FrameworkMbed"),
     get_source_files(eixdata.get("FILES", []))
 ))
 

platformio/builder/scripts/frameworks/opencm3.py

@@ -2,7 +2,12 @@
 # See LICENSE for details.
 
 """
-    Build script for OpenCM3 Framework.
+The libopencm3 framework aims to create a free/libre/open-source
+firmware library for various ARM Cortex-M0(+)/M3/M4 microcontrollers,
+including ST STM32, Ti Tiva and Stellaris, NXP LPC 11xx, 13xx, 15xx,
+17xx parts, Atmel SAM3, Energy Micro EFM32 and others.
+
+http://www.libopencm3.org/wiki/Main_Page
 """
 
 import re

platformio/builder/scripts/frameworks/spl.py

@@ -2,7 +2,12 @@
 # See LICENSE for details.
 
 """
-    Build script for SPL Framework
+The ST Standard Peripheral Library provides a set of functions for
+handling the peripherals on the STM32 Cortex-M3 family.
+The idea is to save the user (the new user, in particular) having to deal
+directly with the registers.
+
+http://www.st.com/web/en/catalog/tools/FM147/CL1794/SC961/SS1743?sc=stm32embeddedsoftware
 """
 
 from os.path import join

platformio/builder/scripts/nxplpc.py

@@ -16,7 +16,7 @@ def UploadToDisk(target, source, env):  # pylint: disable=W0613,W0621
     env.AutodetectUploadPort()
     copyfile(join(env.subst("$BUILD_DIR"), "firmware.bin"),
              join(env.subst("$UPLOAD_PORT"), "firmware.bin"))
-    print ("Firmware has been successfully uploaded.\n" +
+    print ("Firmware has been successfully uploaded.\n"
            "Please restart your board.")
 
 env = DefaultEnvironment()