def generate_packages(packages, is_embedded): if not packages: return allpackages = get_packages() lines = [] lines.append(""" Packages -------- """) lines.append(""".. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in packages.iteritems(): assert type_ in allpackages contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format(type_=type_, contents=", ".join(contitems))) if is_embedded: lines.append(""" .. warning:: **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file). **Windows Users:** Please check that you have correctly installed USB driver from board manufacturer """) return "\n".join(lines)
def generate_packages(packages): allpackages = get_packages() lines = [] lines.append(""".. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in packages.iteritems(): assert type_ in allpackages contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format( type_=type_, contents=", ".join(contitems))) lines.append(""" .. warning:: **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file). """) return "\n".join(lines)
def update_create_platform_doc(): allpackages = get_packages() lines = [] lines.append(""".. _platform_creating_packages: Packages -------- *PlatformIO* has pre-built packages for the most popular operation systems: *Mac OS*, *Linux (+ARM)* and *Windows*. .. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in sorted(allpackages.iteritems()): contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format(type_=type_, contents=", ".join(contitems))) with open( join(util.get_source_dir(), "..", "docs", "platforms", "creating_platform.rst"), "r+") as fp: content = fp.read() fp.seek(0, 0) fp.write( content[:content.index(".. _platform_creating_packages:")] + "\n".join(lines) + "\n\n" + content[content.index(".. _platform_creating_manifest_file:"):])
def generate_packages(platform, packages, is_embedded): if not packages: return allpackages = get_packages() lines = [] lines.append(""" Packages -------- """) lines.append(""".. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in packages.iteritems(): assert type_ in allpackages contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format( type_=type_, contents=", ".join(contitems))) if is_embedded: lines.append(""" .. warning:: **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file). """) if platform == "teensy": lines.append(""" **Windows Users:** Teensy programming uses only Windows built-in HID drivers. When Teensy is programmed to act as a USB Serial device, Windows XP, Vista, 7 and 8 require `this serial driver <http://www.pjrc.com/teensy/serial_install.exe>`_ is needed to access the COM port your program uses. No special driver installation is necessary on Windows 10. """) else: lines.append(""" **Windows Users:** Please check that you have correctly installed USB driver from board manufacturer """) return "\n".join(lines)
def generate_packages(packages, is_embedded): if not packages: return allpackages = get_packages() lines = [] lines.append(""" Packages -------- """) lines.append(""".. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in packages.iteritems(): assert type_ in allpackages contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format( type_=type_, contents=", ".join(contitems))) if is_embedded: lines.append(""" .. warning:: **Linux Users:** Don't forget to install "udev" rules file `99-platformio-udev.rules <https://github.com/platformio/platformio/blob/develop/scripts/99-platformio-udev.rules>`_ (an instruction is located in the file). **Windows Users:** Please check that you have correctly installed USB driver from board manufacturer """) return "\n".join(lines)
def update_create_platform_doc(): allpackages = get_packages() lines = [] lines.append(""".. _platform_creating_packages: Packages -------- *PlatformIO* has pre-built packages for the most popular operation systems: *Mac OS*, *Linux (+ARM)* and *Windows*. .. list-table:: :header-rows: 1 * - Name - Contents""") for type_, data in sorted(allpackages.iteritems()): contitems = [ "`%s <%s>`_" % (name, url) for name, url in allpackages[type_] ] lines.append(""" * - ``{type_}`` - {contents}""".format( type_=type_, contents=", ".join(contitems))) with open(join(util.get_source_dir(), "..", "docs", "platforms", "creating_platform.rst"), "r+") as fp: content = fp.read() fp.seek(0, 0) fp.write( content[:content.index(".. _platform_creating_packages:")] + "\n".join(lines) + "\n\n" + content[content.index(".. _platform_creating_manifest_file:"):] )