Function runBoardExample

kikit/doc.py:81–124

Run kikit CLI command with args - omitting the output file name. Prints a markdown with the command and includes a generated board image. Generating images runs in parallel, so do not forget to invoke runBoardExampleJoin() at the end of your script.

(name, args)

runExampleThreads = []

def runBoardExample(name, args):
    """
    Run kikit CLI command with args - omitting the output file name. Prints a
    markdown with the command and includes a generated board image.

    Generating images runs in parallel, so do not forget to invoke
    runBoardExampleJoin() at the end of your script.
    """
    realArgs = ["python3", "-m", "kikit.ui"] + list(chain(*args))

    # We print first, so in a case of failure we have the command in a nice
    # copy-paste-ready form
    args[0] = ["kikit"] + args[0]
    args[-1] = args[-1] + ["panel.kicad_pcb"]

    print('!!! example "Panelization command"\n')

    print('    === "Linux/macOS"')
    print("        ```")
    for i, c in enumerate(args):
        if i == 0:
            print("        ", end="")
        else:
            print("            ", end="")
        end = "\n" if i + 1 == len(args) else " \\\n"
        print(" ".join(quotePosix(c)), end=end)
    print("        ```")
    print("")
    print('    === "Windows"')
    print("        ```")
    for i, c in enumerate(args):
        if i == 0:
            print("        ", end="")
        else:
            print("            ", end="")
        end = "\n" if i + 1 == len(args) else " ^\n"
        print(" ".join(quoteWindows(c)), end=end)
    print("        ```\n")
    print("    ![{0}](../resources/{0}.png)".format(name))

    t = threading.Thread(target=lambda: panelizeAndDraw(name, realArgs))
    t.start()
    global runExampleThreads
    runExampleThreads.append(t)

def runScriptingExample(name, args):
    """