mirror of
https://github.com/TinyTapeout/tt-support-tools.git
synced 2026-11-03 04:36:09 +01:00
feat: add interactive document checker (#164)
* feat: add interactive document checker This utility can be used to audit the documentation of the projects on the shuttle, marking them to be removed from the datasheet. Usage: `python3 tt/configure.py --doc-check`, inspect using `nano` controls, then answer prompt upon exiting `nano`.
This commit is contained in:
+10
-1
@@ -14,7 +14,7 @@ from typing import Dict, List, TypedDict
|
||||
import yaml
|
||||
|
||||
from config import Config
|
||||
from documentation import Docs
|
||||
from documentation import Docs, interactive_doc_checker
|
||||
from logo import LogoGenerator
|
||||
from project import Project
|
||||
from rom import ROMFile
|
||||
@@ -276,6 +276,12 @@ if __name__ == "__main__":
|
||||
default="1.0.0",
|
||||
nargs="?",
|
||||
)
|
||||
parser.add_argument(
|
||||
"--doc-check",
|
||||
help="interactive project document checker",
|
||||
action="store_const",
|
||||
const=True,
|
||||
)
|
||||
|
||||
args = parser.parse_args()
|
||||
|
||||
@@ -335,3 +341,6 @@ if __name__ == "__main__":
|
||||
if args.build_datasheet:
|
||||
shuttle.configure_mux()
|
||||
docs.build_datasheet(args.template_version, args.doc_tapeout_index)
|
||||
|
||||
if args.doc_check:
|
||||
interactive_doc_checker()
|
||||
|
||||
Reference in New Issue
Block a user