mirror of
https://github.com/TinyTapeout/tt-support-tools.git
synced 2026-11-03 04:36:09 +01:00
doc preview
This commit is contained in:
@@ -4,9 +4,7 @@
|
||||
|
||||
* Author: {author}
|
||||
* Description: {description}
|
||||
* [Extra docs]({doc_link})
|
||||
* Clock: {clock_hz} Hz
|
||||
* External hardware: {external_hw}
|
||||
* Language: {language}
|
||||
|
||||
### How it works
|
||||
|
||||
|
||||
+1
-1
@@ -11,7 +11,7 @@ import cairosvg
|
||||
# makes sure that the basic info is present
|
||||
def check_yaml_docs(yaml):
|
||||
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']:
|
||||
logging.error("missing key {} in documentation".format(key))
|
||||
exit(1)
|
||||
|
||||
Reference in New Issue
Block a user