TinyTapeout/tt-support-tools
1
0
Fork 0
mirror of https://github.com/TinyTapeout/tt-support-tools.git synced 2026-11-03 04:36:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc preview

Browse Source
This commit is contained in:
Matt Venn
2023-02-23 17:43:52 +01:00
parent 4294db2f21
commit dd07aaa1b1
2 changed files with 2 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/project_preview.md
+1 -3
View File
@@ -4,9 +4,7 @@
* Author: {author} * Author: {author}
* Description: {description} * Description: {description}
* [Extra docs]({doc_link}) * Language: {language}
* Clock: {clock_hz} Hz
* External hardware: {external_hw}
### How it works ### How it works
documentation.py
+1 -1
View File
@@ -11,7 +11,7 @@ import cairosvg
# makes sure that the basic info is present # makes sure that the basic info is present
def check_yaml_docs(yaml): def check_yaml_docs(yaml):
logging.info("checking docs") logging.info("checking docs")
for key in ['author', 'title', 'description', 'how_it_works', 'how_to_test', 'language']: for key in ['author', 'title', 'description', 'how_it_works', 'how_to_test', 'language', 'inputs', 'outputs']:
if key not in yaml['documentation']: if key not in yaml['documentation']:
logging.error("missing key {} in documentation".format(key)) logging.error("missing key {} in documentation".format(key))
exit(1) exit(1)