From e4462d7546737f1f0613a77d46f8e3f786a0b2ab Mon Sep 17 00:00:00 2001 From: Ivan Kravets Date: Thu, 19 Jul 2018 16:19:10 +0300 Subject: [PATCH] Add Infineon XMC dev/platform // Resolve #471 --- docs | 2 +- examples | 2 +- scripts/docspregen.py | 38 +++++++++++++++++--------------------- 3 files changed, 19 insertions(+), 23 deletions(-) diff --git a/docs b/docs index a77ecd12..eb2b343a 160000 --- a/docs +++ b/docs @@ -1 +1 @@ -Subproject commit a77ecd12952ff66b799357d505e9a09c24a4a5ec +Subproject commit eb2b343ac608d9515d01f70ccfaefb0a3b85facc diff --git a/examples b/examples index 8e11abaa..965ab1cb 160000 --- a/examples +++ b/examples @@ -1 +1 @@ -Subproject commit 8e11abaafcfac758252f1df820d694a873e09e36 +Subproject commit 965ab1cb2852d06b652b49944830d2f81d563db1 diff --git a/scripts/docspregen.py b/scripts/docspregen.py index 17c1b6ba..9da8ac18 100644 --- a/scripts/docspregen.py +++ b/scripts/docspregen.py @@ -240,6 +240,8 @@ def generate_platform(name, has_extra=False): limitations under the License. """) p = PlatformFactory.newPlatform(name) + assert p.repository_url.endswith(".git") + github_url = p.repository_url[:-4] lines.append(".. _platform_%s:" % p.name) lines.append("") @@ -272,17 +274,13 @@ Examples -------- Examples are listed from `%s development platform repository <%s>`_: -""" % (p.title, - campaign_url( - "https://github.com/platformio/platform-%s/tree/develop/examples" % - p.name))) +""" % (p.title, campaign_url("%s/tree/master/examples" % github_url))) examples_dir = join(p.get_dir(), "examples") if isdir(examples_dir): for eitem in os.listdir(examples_dir): if not isdir(join(examples_dir, eitem)): continue - url = ("https://github.com/platformio/platform-%s" - "/tree/develop/examples/%s" % (p.name, eitem)) + url = "%s/tree/master/examples/%s" % (github_url, eitem) lines.append("* `%s <%s>`_" % (eitem, campaign_url(url))) # @@ -300,7 +298,7 @@ Examples are listed from `%s development platform repository <%s>`_: Stable and upstream versions ---------------------------- -You can switch between `stable releases `__ +You can switch between `stable releases <{github_url}/releases>`__ of {title} development platform and the latest upstream version using :ref:`projectconf_env_platform` option in :ref:`projectconf` as described below. @@ -325,9 +323,9 @@ Upstream .. code-block:: ini [env:upstream_develop] - platform = https://github.com/platformio/platform-{name}.git + platform = {github_url}.git board = ... -""".format(name=p.name, title=p.title)) +""".format(name=p.name, title=p.title, github_url=github_url)) # # Packages @@ -460,11 +458,12 @@ Examples -------- """) for manifest in compatible_platforms: - lines.append("* `%s for %s <%s>`_" % ( - data['title'], manifest['title'], - campaign_url( - "https://github.com/platformio/platform-%s/tree/develop/examples" - % manifest['name']))) + p = PlatformFactory.newPlatform(manifest['name']) + lines.append( + "* `%s for %s <%s>`_" % + (data['title'], manifest['title'], + campaign_url( + "%s/tree/master/examples" % p.repository_url[:-4]))) # Platforms lines.append(""" @@ -713,8 +712,7 @@ def update_project_examples(): for manifest in PLATFORM_MANIFESTS: p = PlatformFactory.newPlatform(manifest['name']) - github_platform_url = ( - "https://github.com/platformio/platform-%s" % p.name) + github_url = p.repository_url[:-4] # Platform README platform_examples_dir = join(p.get_dir(), "examples") @@ -723,8 +721,7 @@ def update_project_examples(): for item in os.listdir(platform_examples_dir): if not isdir(join(platform_examples_dir, item)): continue - url = ("%s/tree/develop/examples/%s" % (github_platform_url, - item)) + url = "%s/tree/master/examples/%s" % (github_url, item) examples_md_lines.append("* [%s](%s)" % (item, url)) readme_dir = join(project_examples_dir, "platforms", p.name) @@ -745,14 +742,13 @@ def update_project_examples(): if framework['name'] not in framework_examples_md_lines: framework_examples_md_lines[framework['name']] = [] lines = [] - lines.append("- [%s](%s)" % (p.title, github_platform_url)) + lines.append("- [%s](%s)" % (p.title, github_url)) lines.extend(" %s" % l for l in examples_md_lines) lines.append("") framework_examples_md_lines[framework['name']].extend(lines) # Root README - url = "https://github.com/platformio/platform-%s/tree/develop/examples" % p.name - line = "* [%s](%s)" % (p.title, url) + line = "* [%s](%s)" % (p.title, "%s/tree/master/examples" % github_url) if p.is_embedded(): embedded.append(line) else: