The-OpenROAD-Project_OpenROAD-flow-scripts/flow/scripts/generate-variables-docs.py

#!/usr/bin/env python3
# variables.yaml is the single source of truth w.r.t. metainformation about
# the ORFS variables.
#
# This script injects an autogenerated section in FlowVariables.md with
# information about the variables from variables.yaml.
import os
import yaml

dir_path = os.path.dirname(os.path.realpath(__file__))

yaml_path = os.path.join(dir_path, "variables.yaml")

with open(yaml_path, "r") as file:
    data = yaml.safe_load(file)

preferred_order = ["synth", "floorplan", "place", "cts", "grt", "route", "final"]
stages = {stage for value in data.values() for stage in value.get("stages", [])}
# convert set of stages to stages in a list in the preferred order, but
# list all stages and sort the rest for a stable order
stages = [stage for stage in preferred_order if stage in stages] + sorted(
    [stage for stage in stages if stage not in preferred_order]
)

markdown_table = ""

markdown_table += "## Variables in alphabetic order\n\n"
table_header = """
| Variable | Description | Default |
| --- | --- | --- |
"""
table_rows = ""
for key in sorted(data):
    value = data[key]
    description = value.get("description", "").replace("\n", " ").strip()
    table_rows += (
        f'| <a name="{key}"></a>{key}'
        + f'{" (deprecated)" if value.get("deprecated", 0) == 1 else ""}'
        + f"| {description}"
        + f'| {value.get("default", "")}'
        + "|\n"
    )

markdown_table += table_header + table_rows

for stage in stages + ["Uncategorized"]:
    markdown_table += f"## {stage} variables\n\n"
    stage_keys = [
        key
        for key in sorted(data)
        if (
            ("stages" in data[key] and stage in data[key]["stages"])
            or ("stages" not in data[key] and stage == "Uncategorized")
            or (
                stage == "All stages"
                and set(data[key].get("stages", [])) == set(stages)
            )
        )
    ]
    markdown_table += "\n".join(map(lambda k: f"- [{k}](#{k})", stage_keys))
    markdown_table += "\n\n"

docs = os.path.join(dir_path, "..", "..", "docs", "user", "FlowVariables.md")
with open(docs, "r") as file:
    lines = file.readlines()

# Find the section to replace
start_marker = "# Automatically generated"
end_marker = "# "
start_index = None
end_index = len(lines)

for i, line in enumerate(lines):
    if line.startswith(start_marker):
        start_index = i + 1
    elif start_index is not None and line.startswith(end_marker):
        end_index = i
        break

if start_index is None:
    raise ValueError("Start marker not found")

# Replace the section with the new table
new_lines = lines[:start_index] + [markdown_table] + lines[end_index:]

# Write the updated content back to FlowVariables.md
with open(docs, "w") as file:
    file.writelines(new_lines)