From f1f72cd37790b29fe2ddced7aa97ee6523c138e3 Mon Sep 17 00:00:00 2001
From: Cristian Maglie <c.maglie@arduino.cc>
Date: Tue, 8 Jun 2021 15:12:17 +0200
Subject: [PATCH 1/2] Added mkdocs workflow
---
.github/workflows/validate-docs.yaml | 45 ++++++++++++++++++++
Taskfile.yml | 5 +++
docs/README.md | 1 +
docs/img/icon_mac_light.png | Bin 0 -> 846 bytes
mkdocs.yml | 59 +++++++++++++++++++++++++++
requirements_docs.txt | 6 +++
6 files changed, 116 insertions(+)
create mode 100644 .github/workflows/validate-docs.yaml
create mode 120000 docs/README.md
create mode 100644 docs/img/icon_mac_light.png
create mode 100644 mkdocs.yml
create mode 100644 requirements_docs.txt
diff --git a/.github/workflows/validate-docs.yaml b/.github/workflows/validate-docs.yaml
new file mode 100644
index 00000000..b5c2d483
--- /dev/null
+++ b/.github/workflows/validate-docs.yaml
@@ -0,0 +1,45 @@
+name: validate-docs
+
+on:
+ pull_request:
+ push:
+
+jobs:
+ validate:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v2
+
+ - name: Install Taskfile
+ uses: arduino/setup-task@v1
+ with:
+ repo-token: ${{ secrets.GITHUB_TOKEN }}
+ version: 3.x
+
+ - name: Setup Go
+ uses: actions/setup-go@v2
+
+ - name: Setup Python
+ uses: actions/setup-python@v1
+ with:
+ python-version: "3.8"
+ architecture: "x64"
+
+ - name: Cache dependencies
+ uses: actions/cache@v2
+ with:
+ path: ~/.cache/pip
+ key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements_docs.txt') }}
+ restore-keys: |
+ ${{ runner.os }}-pip-
+
+ - name: Install Python dependencies
+ run: |
+ python3 -m pip install --upgrade pip
+ python3 -m pip install -r ./requirements_docs.txt
+
+ - name: Build docs website
+ # Ensure the docs build is sane, these docs won't be published
+ run: task docs:build
diff --git a/Taskfile.yml b/Taskfile.yml
index 8864b3d0..6c4e8328 100755
--- a/Taskfile.yml
+++ b/Taskfile.yml
@@ -26,6 +26,11 @@ tasks:
cmds:
- npx {{ .PRETTIER }} --write "**/*.md"
+ docs:build:
+ desc: Build documentation website contents
+ cmds:
+ - mkdocs build -s
+
build:
desc: Build the project
cmds:
diff --git a/docs/README.md b/docs/README.md
new file mode 120000
index 00000000..32d46ee8
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1 @@
+../README.md
\ No newline at end of file
diff --git a/docs/img/icon_mac_light.png b/docs/img/icon_mac_light.png
new file mode 100644
index 0000000000000000000000000000000000000000..b06aa7f3f04c01097fb11eed4c61f96af3b13a4a
GIT binary patch
literal 846
zcmV-U1F`&xP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800006VoOIv0RI60
z0RN!9r;`8x010qNS#tmY79jut79jz)ucP7s000McNliru;R6W_5ETVsSOWk60^3PM
zK~z}7)tAdlRZ$eif5%D#^+Nf;3=)K_oJ9yqAWedxBBCgQv<6`iNKc9=2R3NXsBwQl
zG>NE@NG}7!E*KHy1Ir?a5Wzydg^+#?T89>=d+xp3y+#WTd++tw-#UA(z0NxDk15Di
zQ4&EAg!2|)3y=VcfEi#Icpe17LP0#0bWGBKvePR`9r*wZ$HS6RT0G5%j)Z$H1^kiz
zo?c2Sj&mZ20WSl_fSNo-a2luwrh*_)tOL%=Pr$mxBxw#b15^QXVKQSG{M(yff`>qD
zp1}difusjd7yCmhJauLY!L)f=*y7`kp(u>Kq_#BRH-Kh~T|Lka3})DS80Y{RfC``q
z=mzE^FM1~3@%Ou98kDp$L#XzpIoh@?SG(8gj;B)yX~gliO1dv;%$&OHWSgALHplOj
zlr)<jN!y+5g|jL5;7v}j(RfE<l4w#=mFeu1bj;?ZlE!0fPMc1p<L&kiwE4G}v?@y`
zPf3a<@CPUFk#sy_Q(=02wm#?Uz*-xVHtunIU$aE&25uW~4RFVS-vsJxc@MY+^a5RO
zp93}y*q8u_Cfa<O0`(RMOJu3zm$><AH=nR)4j6U(6`3;hs2$6YtxK|mU^aS7Bz=~&
zVDh_`AD(JV@3E~fc;jZLSZBPB81NZM)sg~9t&$F!ewn0+7@Mo6lW@Gfao6y*<F%N_
zlafXyT{nIpX}zQ$X4Bwou1FfPM13Y{my<nlIEknONhj>fQdD+W!{KRv7Mll7_x&F|
zfTZ@whI5j-BsE$?QEe5lFGFr5t%ItytK1;ztcA_f#kh~r_ee%B&&SBo$z|xoFJ<co
z`wQ3$jAZNyttBf0Cav1#vnxtjk2#yIC0hVC0AKS6{tal1f~U)Y(20~aA;~;|4*}J{
z$Bg}8hJS+-Y3_Wkbbd)cCNU13lJq7A(03tlUVl!VBgH@~uo<W{_80qVJ`I8(#s5S<
Y0hyyk+?!AoumAu607*qoM6N<$f?r~FO#lD@
literal 0
HcmV?d00001
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 00000000..d2c3a8d7
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,59 @@
+# Project information
+site_name: Arduino Firmware Uploader
+site_description: A firmware uploader/updater for Arduino Boards.
+site_url: https://arduino.github.io/arduino-firmware-uploader/
+
+# Repository
+repo_name: arduino/FirmwareUploader
+repo_url: https://github.com/arduino/FirmwareUploader
+edit_uri: ""
+
+# Copyright
+copyright: Copyright 2021 ARDUINO SA (http://www.arduino.cc/)
+
+# Theme
+theme:
+ name: material
+ logo: img/icon_mac_light.png
+ palette:
+ primary: teal
+ accent: orange
+
+# Extensions
+markdown_extensions:
+ - markdown.extensions.admonition
+ - markdown.extensions.codehilite:
+ guess_lang: false
+ - markdown.extensions.def_list
+ - markdown.extensions.footnotes
+ - markdown.extensions.meta
+ - markdown.extensions.toc:
+ permalink: true
+ - pymdownx.arithmatex
+ - pymdownx.betterem:
+ smart_enable: all
+ - pymdownx.caret
+ - pymdownx.critic
+ - pymdownx.details
+ - pymdownx.emoji:
+ emoji_index: !!python/name:pymdownx.emoji.twemoji
+ emoji_generator: !!python/name:pymdownx.emoji.to_svg
+ - pymdownx.inlinehilite
+ - pymdownx.keys
+ - pymdownx.magiclink:
+ repo_url_shorthand: true
+ user: arduino
+ repo: FirmwareUploader
+ - pymdownx.mark
+ - pymdownx.smartsymbols
+ - pymdownx.superfences
+ - pymdownx.tasklist:
+ custom_checkbox: true
+ - pymdownx.tilde
+ - mdx_truly_sane_lists:
+ nested_indent: 2
+ truly_sane: true
+
+# Navigation
+nav:
+ - Documentation Home: README.md
diff --git a/requirements_docs.txt b/requirements_docs.txt
new file mode 100644
index 00000000..65255692
--- /dev/null
+++ b/requirements_docs.txt
@@ -0,0 +1,6 @@
+mkdocs<1.2
+mkdocs-material<5
+mike==0.5.1
+gitpython
+click<7.2
+mdx_truly_sane_lists==1.2
From f57f57fccabb5c21f5b0aa51155218edb38e087e Mon Sep 17 00:00:00 2001
From: Cristian Maglie <c.maglie@arduino.cc>
Date: Mon, 14 Jun 2021 21:49:36 +0200
Subject: [PATCH 2/2] Update mkdocs.yml
Co-authored-by: per1234 <accounts@perglass.com>
---
mkdocs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/mkdocs.yml b/mkdocs.yml
index d2c3a8d7..bd536c46 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,7 +1,7 @@
# Project information
site_name: Arduino Firmware Uploader
site_description: A firmware uploader/updater for Arduino Boards.
-site_url: https://arduino.github.io/arduino-firmware-uploader/
+site_url: https://arduino.github.io/FirmwareUploader/
# Repository
repo_name: arduino/FirmwareUploader