feat(datasheet): use mustache for shuttle_index

htfab · May 6, 2024 · a2c7055 · a2c7055
1 parent f095b9d
commit a2c7055
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 11 deletions.
diff --git a/docs/shuttle_index_header.md b/docs/shuttle_index_header.md
diff --git a/docs/shuttle_index_header.md.mustache b/docs/shuttle_index_header.md.mustache
@@ -0,0 +1,6 @@
+# {{name}}
+
+This repository contains the GDS file for the [{{name}}](https://tinytapeout.com) project. It was generated from {{git_repo}}@{{git_commit}}.
+
+## Project Index
+
diff --git a/documentation.py b/documentation.py
@@ -24,13 +24,16 @@ def __init__(self, config: Config, projects: List[Project]):
     def build_index(self, filename: str = "shuttle_index.md"):
         logging.info(f"building {filename}")
         repo = git.Repo(".")
-        readme = self.load_doc_template("shuttle_index_header.md")
+        readme = self.load_doc_template("shuttle_index_header.md.mustache")
         with open(filename, "w") as fh:
             fh.write(
-                readme.format(
-                    name=self.config["name"],
-                    git_repo=get_first_remote(repo),
-                    git_commit=repo.head.commit.hexsha,
+                chevron.render(
+                    readme,
+                    {
+                        "name": self.config["name"],
+                        "git_repo": get_first_remote(repo),
+                        "git_commit": repo.head.commit.hexsha,
+                    },
                 )
             )
             fh.write("| Address | Author | Title | Type | Git Repo |\n")