From 1218c7aacaa5d66191799089e256bc1501cc5622 Mon Sep 17 00:00:00 2001 From: Masaya Kataoka Date: Sat, 7 Dec 2024 01:33:32 +0900 Subject: [PATCH] update document (#374) * update kibot.yaml Signed-off-by: Masaya Kataoka * update document Signed-off-by: Masaya Kataoka --------- Signed-off-by: Masaya Kataoka --- .github/workflows/docker/kicad/kibot.yaml | 5 +++++ .../computer_sensor_board.md | 2 ++ .../miniv_motor_controller_board.md | 2 ++ docs/mkdocs.yml | 1 + pyproject.toml | 1 + uv.lock | 18 ++++++++++++++++++ 6 files changed, 29 insertions(+) diff --git a/.github/workflows/docker/kicad/kibot.yaml b/.github/workflows/docker/kicad/kibot.yaml index 051a31cd..3c0cd321 100644 --- a/.github/workflows/docker/kicad/kibot.yaml +++ b/.github/workflows/docker/kicad/kibot.yaml @@ -76,6 +76,11 @@ outputs: group_fields: Value,Footprint,Datasheet extra_data_file: "%F.xml" dir: /workspace/bom + - name: output CSV BoM + type: bom + options: + format: XML + dir: /workspace/bom - name: Make zipfile of the gerber and drill file. type: compress dir: /workspace/zip diff --git a/docs/docs/circuit/computer_sensor_board/computer_sensor_board.md b/docs/docs/circuit/computer_sensor_board/computer_sensor_board.md index 915d90f1..c4143662 100644 --- a/docs/docs/circuit/computer_sensor_board/computer_sensor_board.md +++ b/docs/docs/circuit/computer_sensor_board/computer_sensor_board.md @@ -37,3 +37,5 @@ Under development. [Open with fullscreen](kibot_output/bom/computer_sensor_board-ibom.html){ .md-button .md-button--primary } + +@akizuki_denshi_order_button(./kibot_output/bom/computer_sensor_board-bom.xml) diff --git a/docs/docs/circuit/miniv_motor_controller_board/miniv_motor_controller_board.md b/docs/docs/circuit/miniv_motor_controller_board/miniv_motor_controller_board.md index 3fbbd606..d6647710 100644 --- a/docs/docs/circuit/miniv_motor_controller_board/miniv_motor_controller_board.md +++ b/docs/docs/circuit/miniv_motor_controller_board/miniv_motor_controller_board.md @@ -32,3 +32,5 @@ Under development. [Open with fullscreen](kibot_output/bom/miniv_motor_controller_board-ibom.html){ .md-button .md-button--primary } + +@akizuki_denshi_order_button(./kibot_output/bom/miniv_motor_controller_board-bom.xml) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index d206140d..947e3cac 100755 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -32,6 +32,7 @@ theme: # Plugins plugins: + - akizukidenshi_order_button - github-dashboard - search - inline-select-svg diff --git a/pyproject.toml b/pyproject.toml index 3a63dc46..0098689c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,4 +17,5 @@ dependencies = [ "python-github-api>=0.1.1", "python-markdown-math>=0.8", "mkdocs-inline-select-svg-plugin>=0.1.0", + "mkdocs-order-button>=0.1.0", ] diff --git a/uv.lock b/uv.lock index 89432718..04fd71be 100644 --- a/uv.lock +++ b/uv.lock @@ -440,6 +440,22 @@ wheels = [ { url = "https://files.pythonhosted.org/packages/a5/9a/2933f5609fad97092a054eb51a830b017f0c338e251be8d518d90a3531fb/mkdocs_mermaid2_plugin-1.1.1-py3-none-any.whl", hash = "sha256:4e25876b59d1e151ca33a467207b346404b4a246f4f24af5e44c32408e175882", size = 10074 }, ] +[[package]] +name = "mkdocs-order-button" +version = "0.1.0" +source = { registry = "https://pypi.org/simple" } +dependencies = [ + { name = "markdown" }, + { name = "mkdocs" }, + { name = "mkdocs-material" }, + { name = "plantuml-markdown" }, + { name = "pymdown-extensions" }, +] +sdist = { url = "https://files.pythonhosted.org/packages/a7/10/2d32f57a8b941dbcb91c35518fcb518c80cab718df481e156f78bed0c206/mkdocs_order_button-0.1.0.tar.gz", hash = "sha256:51c80a7305e402c6171739a7d31389984fd385f1edb055be2a6ef1f5482ef668", size = 7834 } +wheels = [ + { url = "https://files.pythonhosted.org/packages/f9/b9/f76a924c34c53eabd7b77f8171a315308babfc31644d437084235bbd8b49/mkdocs_order_button-0.1.0-py3-none-any.whl", hash = "sha256:9afc1c7cae43fce7964116087fa7406e8da9bff75d7d6112ca3560b0bd6ddee1", size = 11488 }, +] + [[package]] name = "numpy" version = "2.1.2" @@ -512,6 +528,7 @@ dependencies = [ { name = "mkdocs-inline-select-svg-plugin" }, { name = "mkdocs-material" }, { name = "mkdocs-mermaid2-plugin" }, + { name = "mkdocs-order-button" }, { name = "pandas" }, { name = "plantuml-markdown" }, { name = "pymdown-extensions" }, @@ -528,6 +545,7 @@ requires-dist = [ { name = "mkdocs-inline-select-svg-plugin", specifier = ">=0.1.0" }, { name = "mkdocs-material", specifier = ">=9.5.18" }, { name = "mkdocs-mermaid2-plugin", specifier = ">=1.1.1" }, + { name = "mkdocs-order-button", specifier = ">=0.1.0" }, { name = "pandas", specifier = ">=2.2.3" }, { name = "plantuml-markdown", specifier = ">=3.10.4" }, { name = "pymdown-extensions", specifier = ">=10.4" },