From 665ab22de55ac74e80c85390e6d4ed1681a05319 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20Szczodrzy=C5=84ski?= Date: Tue, 6 Dec 2022 21:33:48 +0100 Subject: [PATCH] [docs] Generate JSON file with supported boards --- .github/workflows/docs.yml | 11 +++++++++++ docs/build_json.py | 17 +++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 docs/build_json.py diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d493c46..d55d1f6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,6 +13,17 @@ jobs: - name: Checkout main uses: actions/checkout@v2 + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.10' + + - name: Install ltchiptool + run: pip install ltchiptool + + - name: Generate static JSON files + run: python docs/build_json.py + - name: Set custom domain run: | mkdir -p site/ diff --git a/docs/build_json.py b/docs/build_json.py new file mode 100644 index 0000000..924ed82 --- /dev/null +++ b/docs/build_json.py @@ -0,0 +1,17 @@ +import json + +from ltchiptool import Board +from update_docs import board_obj_sort + +boards = map(Board, Board.get_list()) +boards = list(sorted(boards, key=board_obj_sort)) +for i, board in enumerate(boards): + boards[i] = dict( + name=board.name, + title=board.title, + vendor=board.vendor, + mcu=board.family.short_name, + ) + +with open("boards.json", "w") as f: + json.dump(boards, f)