From cc08bb0fd0feafefbd598efad5f02613e949d44f Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Fri, 9 Feb 2018 14:31:22 +0200 Subject: [PATCH] Document how to switch between stable release and upstream dev/platform --- docs | 2 +- scripts/docspregen.py | 26 ++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/docs b/docs index b32cd4a5..2d67adb9 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit b32cd4a5f86d783276fc272f17fcd70d196ad9fa +Subproject commit 2d67adb9edcbdceef5ed78b31896030f07e5e534 diff --git a/scripts/docspregen.py b/scripts/docspregen.py index 4384eee6..51b2ff48 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -290,6 +290,32 @@ Examples are listed from `%s development platform repository <%s>`_: generate_debug_boards( compatible_boards, skip_columns=["Platform"])) + # + # Development version of dev/platform + # + lines.append(""" +Stable and upstream versions +---------------------------- + +You can switch between `stable releases `__ +of {title} development platform and the latest upstream version using +:ref:`projectconf_env_platform` option as described below: + +.. code-block:: ini + + ; Custom stable version + [env:stable] + platform ={name}@x.y.z + board = ... + ... + + ; The latest upstream/development version + [env:upstream] + platform = https://github.com/platformio/platform-{name}.git + board = ... + ... +""".format(name=p.name, title=p.title)) + # # Packages #