mirror of
https://github.com/TinyTapeout/tt-support-tools.git
synced 2026-11-03 04:36:09 +01:00
feat(docs): support new info.yaml/info.md format
This commit is contained in:
Uri Shaked
+11
-19
@@ -1,28 +1,20 @@
|
||||
## {title}
|
||||
|
||||
{picture_link}
|
||||
# {title}
|
||||
|
||||
* Author: {author}
|
||||
* Description: {description}
|
||||
* Language: {language}
|
||||
|
||||
### How it works
|
||||
{info}
|
||||
|
||||
{how_it_works}
|
||||
|
||||
### How to test
|
||||
|
||||
{how_to_test}
|
||||
|
||||
### IO
|
||||
## Pinout
|
||||
|
||||
| # | Input | Output | Bidirectional |
|
||||
|---|--------------|--------------|--------------------|
|
||||
| 0 | {inputs[0]} | {outputs[0]} | {bidirectional[0]} |
|
||||
| 1 | {inputs[1]} | {outputs[1]} | {bidirectional[1]} |
|
||||
| 2 | {inputs[2]} | {outputs[2]} | {bidirectional[2]} |
|
||||
| 3 | {inputs[3]} | {outputs[3]} | {bidirectional[3]} |
|
||||
| 4 | {inputs[4]} | {outputs[4]} | {bidirectional[4]} |
|
||||
| 5 | {inputs[5]} | {outputs[5]} | {bidirectional[5]} |
|
||||
| 6 | {inputs[6]} | {outputs[6]} | {bidirectional[6]} |
|
||||
| 7 | {inputs[7]} | {outputs[7]} | {bidirectional[7]} |
|
||||
| 0 | {ui[0]} | {uo[0]} | {uio[0]} |
|
||||
| 1 | {ui[1]} | {uo[1]} | {uio[1]} |
|
||||
| 2 | {ui[2]} | {uo[2]} | {uio[2]} |
|
||||
| 3 | {ui[3]} | {uo[3]} | {uio[3]} |
|
||||
| 4 | {ui[4]} | {uo[4]} | {uio[4]} |
|
||||
| 5 | {ui[5]} | {uo[5]} | {uio[5]} |
|
||||
| 6 | {ui[6]} | {uo[6]} | {uio[6]} |
|
||||
| 7 | {ui[7]} | {uo[7]} | {uio[7]} |
|
||||
|
||||
+73
-19
@@ -1,3 +1,4 @@
|
||||
import copy
|
||||
import csv
|
||||
import glob
|
||||
import json
|
||||
@@ -19,6 +20,33 @@ from markdown_utils import limit_markdown_headings
|
||||
|
||||
CELL_URL = "https://skywater-pdk.readthedocs.io/en/main/contents/libraries/sky130_fd_sc_hd/cells/"
|
||||
|
||||
PINOUT_KEYS = [
|
||||
"ui[0]",
|
||||
"ui[1]",
|
||||
"ui[2]",
|
||||
"ui[3]",
|
||||
"ui[4]",
|
||||
"ui[5]",
|
||||
"ui[6]",
|
||||
"ui[7]",
|
||||
"uo[0]",
|
||||
"uo[1]",
|
||||
"uo[2]",
|
||||
"uo[3]",
|
||||
"uo[4]",
|
||||
"uo[5]",
|
||||
"uo[6]",
|
||||
"uo[7]",
|
||||
"uio[0]",
|
||||
"uio[1]",
|
||||
"uio[2]",
|
||||
"uio[3]",
|
||||
"uio[4]",
|
||||
"uio[5]",
|
||||
"uio[6]",
|
||||
"uio[7]",
|
||||
]
|
||||
|
||||
|
||||
with open(os.path.join(os.path.dirname(__file__), "tile_sizes.yaml"), "r") as stream:
|
||||
tile_sizes = yaml.safe_load(stream)
|
||||
@@ -510,47 +538,73 @@ class Project:
|
||||
# makes sure that the basic info is present
|
||||
def check_yaml_docs(self):
|
||||
yaml = self.yaml
|
||||
logging.info("checking docs")
|
||||
logging.info("Checking docs")
|
||||
had_error = False
|
||||
if yaml.get("yaml_version", "") != 6:
|
||||
logging.error("yaml_version must be 6")
|
||||
had_error = True
|
||||
|
||||
for key in [
|
||||
"author",
|
||||
"tiles",
|
||||
"title",
|
||||
"description",
|
||||
"how_it_works",
|
||||
"how_to_test",
|
||||
"language",
|
||||
"inputs",
|
||||
"outputs",
|
||||
"bidirectional",
|
||||
]:
|
||||
if key not in yaml["documentation"]:
|
||||
logging.error("missing key {} in documentation".format(key))
|
||||
exit(1)
|
||||
if yaml["documentation"][key] == "":
|
||||
logging.error("missing value for {} in documentation".format(key))
|
||||
if key not in yaml["project"]:
|
||||
logging.error("Missing key {} in 'project'".format(key))
|
||||
had_error = True
|
||||
elif yaml["project"][key] == "":
|
||||
logging.error("Missing value for {} in 'project'".format(key))
|
||||
had_error = True
|
||||
|
||||
for key in PINOUT_KEYS:
|
||||
if key not in yaml["pinout"]:
|
||||
logging.error("Missing key {} in 'pinout'".format(key))
|
||||
had_error = True
|
||||
|
||||
info_md = os.path.join(self.local_dir, "docs/info.md")
|
||||
if not os.path.exists(info_md):
|
||||
logging.error("Missing docs/info.md file")
|
||||
had_error = True
|
||||
else:
|
||||
with open(info_md) as fh:
|
||||
info_md_content = fh.read()
|
||||
if "# How it works\n\nExplain how your project works" in info_md_content:
|
||||
logging.error("Missing 'How it works' section in docs/info.md")
|
||||
had_error = True
|
||||
if "# How to test\n\nExplain how to use your project" in info_md_content:
|
||||
logging.error("Missing 'How to use' section in docs/info.md")
|
||||
had_error = True
|
||||
|
||||
if had_error:
|
||||
exit(1)
|
||||
|
||||
# use pandoc to create a single page PDF preview
|
||||
def create_pdf(self):
|
||||
yaml = self.yaml
|
||||
yaml = yaml["documentation"]
|
||||
logging.info("creating pdf")
|
||||
pinout = yaml["pinout"]
|
||||
template_args = copy.deepcopy(yaml["project"])
|
||||
template_args["ui"] = [pinout["ui[{}]".format(i)] for i in range(8)]
|
||||
template_args["uo"] = [pinout["uo[{}]".format(i)] for i in range(8)]
|
||||
template_args["uio"] = [pinout["uio[{}]".format(i)] for i in range(8)]
|
||||
|
||||
logging.info("Creating PDF")
|
||||
script_dir = os.path.dirname(os.path.realpath(__file__))
|
||||
with open(os.path.join(script_dir, "docs/project_header.md")) as fh:
|
||||
doc_header = fh.read()
|
||||
with open(os.path.join(script_dir, "docs/project_preview.md")) as fh:
|
||||
doc_template = fh.read()
|
||||
info_md = os.path.join(self.local_dir, "docs/info.md")
|
||||
with open(info_md) as fh:
|
||||
template_args["info"] = fh.read()
|
||||
|
||||
with open("datasheet.md", "w") as fh:
|
||||
fh.write(doc_header)
|
||||
# handle pictures
|
||||
yaml["picture_link"] = ""
|
||||
if yaml["picture"]:
|
||||
picture_name = yaml["picture"]
|
||||
yaml["picture_link"] = "".format(picture_name)
|
||||
|
||||
# now build the doc & print it
|
||||
try:
|
||||
doc = doc_template.format(**yaml)
|
||||
doc = doc_template.format(**template_args)
|
||||
fh.write(doc)
|
||||
fh.write("\n\\pagebreak\n")
|
||||
except IndexError:
|
||||
|
||||
Reference in New Issue
Block a user