From 59b30706b8d3bee044f208d8847be7b25c262e8e Mon Sep 17 00:00:00 2001
From: MattHag <16444067+MattHag@users.noreply.github.com>
Date: Mon, 1 Jul 2024 14:03:50 +0200
Subject: [PATCH] docs: Use mkdocs for public documentation (#2527)
* Add mkdocs config
Build and debug docs locally:
mkdocs serve
* Add mkdocs config
* Introduce GitHub action for mkdocs
* Delete outdated doc files
* Generate Python documentation
* Clean up docs
- Remove ToDos from public docs
---
.github/workflows/gh-pages.yml | 53 +++++++++++++++++++
docs/_config.yml | 9 ----
docs/_layouts/default.html | 53 -------------------
docs/_layouts/page.html | 47 ----------------
docs/capabilities.md | 2 +-
docs/{assets/favicon.png => img/favicon.ico} | Bin
docs/img/favicon.png | Bin 0 -> 1772 bytes
docs/{assets => img}/solaar.svg | 0
docs/implementation.md | 14 -----
docs/reference/developer_documentation.md | 26 +++++++++
jekyll/images/bg_hr.png | Bin 96 -> 0 bytes
jekyll/images/blacktocat.png | Bin 432 -> 0 bytes
jekyll/images/icon_download.png | Bin 230 -> 0 bytes
jekyll/images/sprite_download.png | Bin 14650 -> 0 bytes
mkdocs.yml | 33 ++++++++++++
15 files changed, 113 insertions(+), 124 deletions(-)
create mode 100644 .github/workflows/gh-pages.yml
delete mode 100644 docs/_config.yml
delete mode 100644 docs/_layouts/default.html
delete mode 100644 docs/_layouts/page.html
rename docs/{assets/favicon.png => img/favicon.ico} (100%)
create mode 100644 docs/img/favicon.png
rename docs/{assets => img}/solaar.svg (100%)
create mode 100644 docs/reference/developer_documentation.md
delete mode 100644 jekyll/images/bg_hr.png
delete mode 100644 jekyll/images/blacktocat.png
delete mode 100644 jekyll/images/icon_download.png
delete mode 100644 jekyll/images/sprite_download.png
create mode 100644 mkdocs.yml
diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
new file mode 100644
index 000000000..701f16479
--- /dev/null
+++ b/.github/workflows/gh-pages.yml
@@ -0,0 +1,53 @@
+name: Deploy to GitHub Pages
+on:
+ push:
+ branches:
+ - master
+ - '*doc*'
+
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+concurrency:
+ group: 'pages'
+ cancel-in-progress: false
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+
+ - name: Set up Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: '3.x'
+
+ - name: Install dependencies
+ run: |
+ pip install mkdocs mkdocs-rtd-dropdown mkdocs-mermaid2-plugin mkdocstrings[python]
+
+ - name: Build and deploy
+ run: |
+ mkdocs build
+
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: 'site'
+
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ needs: build
+
+ steps:
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v4
diff --git a/docs/_config.yml b/docs/_config.yml
deleted file mode 100644
index d3ad18e3d..000000000
--- a/docs/_config.yml
+++ /dev/null
@@ -1,9 +0,0 @@
-title: Solaar
-description: Linux Device Manager for Logitech Unifying Receivers and Devices.
-tagline: Linux Device Manager for Logitech Unifying Receivers and Devices.
-owner: pwr-Solaar
-owner_url: https://github.com/pwr-Solaar
-repository: pwr-Solaar/Solaar
-show_downloads: false
-encoding: utf-8
-theme: jekyll-theme-slate
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
deleted file mode 100644
index d9f797502..000000000
--- a/docs/_layouts/default.html
+++ /dev/null
@@ -1,53 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-{% seo %}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
deleted file mode 100644
index 52ab08012..000000000
--- a/docs/_layouts/page.html
+++ /dev/null
@@ -1,47 +0,0 @@
-
-
-
-
-
-
-
-
-
-{% seo %}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/capabilities.md b/docs/capabilities.md
index 7493255f3..c5549d2fd 100644
--- a/docs/capabilities.md
+++ b/docs/capabilities.md
@@ -80,7 +80,7 @@ that they were bought with.
## Device Settings
Solaar can display quite a few changeable settings of receivers and devices.
-For a list of HID++ features and their support see [the features page](features).
+For a list of HID++ features and their support see [the features page](features.md).
Solaar does not do much beyond using the HID++ protocol to change the
behavior of receivers and devices via changing their settings.
diff --git a/docs/assets/favicon.png b/docs/img/favicon.ico
similarity index 100%
rename from docs/assets/favicon.png
rename to docs/img/favicon.ico
diff --git a/docs/img/favicon.png b/docs/img/favicon.png
new file mode 100644
index 0000000000000000000000000000000000000000..1f290489d692a34c4cb445076630515e00ea7e8d
GIT binary patch
literal 1772
zcmV000U>0dC}Lu>b%78FWQhbW?9;ba!ELWdL_~cP?peYja~^
zaAhuUa%Y?FJQ@H125Ct|K~z|Uy;oasTUQlb=RPD^lJ#&cTfXu`5l)a3Cw@nE4E}=?id^$0`5p1Cvk?7hxDYu`C{oqY&4&0sL7Q@greOV>BpBn4kj
zIi3I%AcTT!f(Yp53kB%rJI#v`3P>AcW&=ma29BgfiNuou&g-9$*>Alb2m~S<(*WqY
z_I8Ndcf1)J7}!l&mV)FKrT{3I>?+vsF?j??E>1xR-5|Y*%RYH?iIj%w-BBk$`|p>7
zlateIZEbCJve$Mdy8pl)Fif@@fDq(W{*h&41>@{HDfE#db6JL_c9`|tTI5OX1OH!H
zzIX8T$k5Oi!7zmjJ}v^Ak7zd4aK054Bi7gTQOQp{koV&nsPbe&};LSJVylmmH69&darmh;??%NFKO0+4)8XJBpQ{I^tR-#f*ut&@*u-ZTO^Q?7bRQw?!@>rnt)
z*0(x7c0qY<;&SdU%vOJW^788V_=P+dE4F>=kfg0H1a2*|To3@F{rh?}gF`0@CN19o
zf!yx!XUB?Lw;w8eu2=Ih`u&3^VuQBbmGX0y09088afjurre*7Iybi|-0EFhI+&ZD|
zZ7#Sn2vG130v{~@Yvx{dj>&3$BG~@vFH0(ArSz2v06@IE%N%ig-hjjLLe>|$H1gw8
z_()^(FJrcD6LK>7KN0}LAhD7iY_3Kw6^tUYHMeUZ9@Ic*`Eb&eE3_9U^<^}
zG(AUUh5LYrX`&dLx*WVWH>2-=^4p2-_E$=6!jc5if>E6ojH+TC5s5^fuXo@16F+zB
zc>pxt+j&Ub)}#OhWKMTNF+TO4W_IQ!xxt{0S}fm)@9owW>xgpQQ!xVNEYr}?l+xE(
z{0_Sv9?x;T)4hi_)Eol?ko(JLg7Xf07#l*AX*8N1HSePlkR&MV_J3qm5CDR%nQ6E%
zy%idqo14)#wp>hFEzg0iyvHAjK-J{bf_l;QqqRJr?wP|s6&vbuhf(O#$ZOe{dTHT=
zczx0q8|W1(<*rDP#Nv=SoNr}MLIBWNJI(Q3*5lEq_V+{&9_UWATfb)Lv~ADEy$;8U
zd}i*?Of*)pxQYZ+SH~vSM&Cb~@5`7?ze={Z)n~_vj-9nhQ{7MUF~QN%lgcaC?Wka7
z2{7Sx@XmYZ0Hm|Nn!f(wxUKhKL1zpgX6yb;O<&(|K2Lt`-o>&l82|>9rb-1RO*JBi
z4}Dkj+0UIewze7oFsbI|SJI89j|ow_QK(9pE#C*g7+YHn+QUbFA3ZkoV%e6ABFT|N
z(g(m&3L|c7(TUrdzLJ`p?$^~dI>G~cdrM(s2ljUByuQDO_O!JoY#jnvrr@97Y9y9e
z=6JtvjASwclq+*LU>GENJ6jUHoy|FMDq>P~H3_|N{NNS=D!#awCY;wd!D?dRF>vxD
zVoQth|9LY~k6dvouibcwjm2Uqm0WR+jYRjQO{V(X740z*An7zwk6gLS-@f~uhj;IK
za$$qPpiWu4Urh`3`y@GUq`d5ty`GDrL=vfG&f^_d+`j#DzuzAPfd2q9N5Rd=#i@n>
O0000Eakt
p!I=D`pM|Zhn2#qQg>3>egM;VK`xktVMFSNuc)I$ztaD0e0szWX7##or
diff --git a/jekyll/images/blacktocat.png b/jekyll/images/blacktocat.png
deleted file mode 100644
index 59248ee9fb23c867441cbf424ef9e18cc0f2c2fe..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 432
zcmeAS@N?(olHy`uVBq!ia0vp^av;pX3?zBp#Z3TG#sNMduK!5~PX%7M1GNj51o;Is
zB+S46e}BJ$K*M{7_2(4=3SK#Vs%2ncl=gIS45?sDQV?UTg9_g`6j*jdDr`rG=rh+NkjeU4@rER=G7>z
zK3g7rx=%*n=H#|>8yl`g-HVpGqp4H1=x&7u*IC(hUnbajES|`B>oh};H#fT6l=f$9_S)X{+k)Cm4sVWn;;Y|3QIJEc
zY4>4Ck6T)kIE^3vtuK%i3T~GXll|0HbXRSGe)QJF{NL=Ram>#F6_)nsqQT{F}sk-2>ZWtz#nGF0uT&
z^fkEGcS-35{WITQS9SJ8ZX=VUaq&_dae@<$yWU^LpZ2l$_r7vHo#WFa
cA1-X+W>9T=7sgjz33NDvr>mdKI;Vst0HC*6&j0`b
diff --git a/jekyll/images/sprite_download.png b/jekyll/images/sprite_download.png
deleted file mode 100644
index ebf5fe207acc973d29d7d3a10e8960c3242576b8..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001
literal 14650
zcmV-AImO0_P)?SXKaLmkne=IXIGcz-a%M5~&pd=_WS5RhVX6`ZHmt=SB=8L6wG-`4=
z`lz}`va&qhXP)uej<5{J-bw(t^lSwnwLd+=v5j*@cb`oL%)hG+nAgg`%%xf3-X>U=!PpoMCTB*TM+8G!L7ye)NF`P4O;L9m$;@%
zGenlLOD$?6j%APusvR)KP(*sP>0uVF4L8S4*wKi^Q=?st6bK;gCFIVhi(h8q4q*!c
zzgl7z9pb)%=qfM>j!_WdnnJ|Dd!PeGh>mdI{_9g8d{0h4nq{fRhL}YKa*Al2Tin*T
z>+A2tL1#P@;Q&Ce9{MqeLc0oq*msLx0Jr+M^`ONS;#vnrTz1}P_`suHPM%y2jByi0
z`q{6$g8=3LXzT0<)V?_oKF2my8pJwtgnd=~O1KXY*0{$T@5TYAJR42>gI~-1CI=6G
z-}lfLF}Vyh8Q{ebb{{y)fh-ks?v&Ij?uk5Z$=v|!R~c^J%6;DULbe=oPpk(Z2p<7J
zyH*H=n*2b0-YrZUa4YBf@mYN1&5z_4AO9WNZX>lFq7kKW$1MuT9SZaL>5&*fNrOVz
zRc^n$U@g(va)Y)*MAlf}Z=Wf@FPrjvj~&kMH{bGbe)7RzV)-)g5tchNIlBtEGXm5_
z>vC~7bMxjX0@>(h^y7qEq#8a;GgjH>n0-ji5m;Xc(k6(G{fgiUalR(GMmd+-&FpjZ
z(YXHuHz9YC@8NkvQ1s4@hP&6>=Ae#XNXld}RC_XDy`zoMu5S+xOhpagbA=3Sq#Bx9
zgcV?I%I^WB!QnfcUrk%4{2l}H7epLHQR#@2&aOZj5->y5LGqL%TVA+AvoLSAUTKCx
z?xN_kzQywp%d0axG4CcmIes8BHCCZM6AtO4@;gSNcOr
zErplM3Is&TxpM71E&7HvtIoNGl6<;(|sjlX>R4>W@@k~&1K@KDC9cq#cfao+3kS<)A%_@%yI
z)M!?mbAELZql-qsc*e2yV{+GBwW3g)=y!IbgnNVM0oJc@!zZ7~L8sl4Er;HK;pYFw
zZGJ&gwre8m0&7|BSDrOkKZxr+_C=g_ub+oN0o2PlJ+Z9>3@igcoL7v)ogB5-s=C
z&x!L;&X;?HestC}8c+Fs{b#uFFX!WGh#I9E;|m475uLkj0w^LOXtMz~c*3cidXLx8
zt{q99gi~n%ZXudx1!}@;g8NY+C0=&%XAt7qc~T-t8XUmZ!w(=&YLZ0bx_%Ts%qOSb
zhno02iSf!i%%6C-7$*(N1g>m_y^ee!cY5_ny!%0~Lfr72amzC?Ya`@tesu1~ilzoh
z18)4ZGdTHfuVt{ltN7iYEr;D=H{&;K>){XJj;}n4_dNI&;F;8B`f+9sw91{sIYE;E
z3Cju34fud#Z~btZl_PPhi7U<&N9*mHAh(M2IeB53#QHP2m@KIC#(BA9eP1~jW5=S=!{Qo8ab*}A67dJHA%J8^|AUn^@k?xo1j^#
zbG}F;%8N%di|hJP@u&8qJ|0CMd4jt@
zyhw!-O=N?-@x`TII;W+yfqKoUvvtt0W|(wg5|AOJOYahyGr
z-wDC*5M%@-Ak`g@BIwe01_f6vhnU@3HXpdoKYsjWhMRwnb&8Wh@Ge*uR4G*}f(Td+
z!YxOh35yGyf>KaL(MFt?`qSEPgEaJtNNq}|!g@$88?anYcxvN1ky6-*f~NVM4w1OV
zGe~mU73jxKo=C;q
z$GF;tnDf|Y+_h^Nvnju4Z9{Yge1yw5NFdLT(D4_yfD7F?qO<9owU`B#l<652ktd(VTIg
zr%w63!*%>F;rGB(Zoy&yzn$OrbLm+ltnYvX*y5BU_kyDlok{%PBc9Lt{{Ld1=EKpo0rZ4PK{*PCUzUQU%)xrW-G{%Q{%5~2gPVa);9B694vof_pP@M8
z(_i^XeDeqYkH7rl_Yp~Np
zosIDj!_;2t#TBLc|(k*=!}_6Ul|$7ZmzADPC0Q#A_AUo|I!8=*pLjjei`
zf|D$C=3%*Z{&@)icYL?wJNE5Dxm=UWanwdGzCaXI93SL|NP7@C3>=fqrUe=R*Kq*=
zBn|)=X!sfeN5I{W&!d*IIVY#81R9BO)J9edmO%;P9p78vJC3dSKkVLgppp@E6-a|g
zECT}A1e25I|5olpZG`@HQ+j1;C9d15WpYp?zz+vjyK^T9-*(4$6TWIqRAi;-QvWJl
zio&yV&Vi^gBFCwq`vJggYEvHsA#ThxOXI`!3FP!_x3mDbcYji2UujlxwQ@OX0;N&f
z9p78wTNVrGS20vv4gfSYad)}tN(R@esi|v|sy0BR&uBRajhN
zfTq4lRxYO&6uTobn>)U@!uPxsSrFc+i2zrdx;6+FsT*n&^apQAu-&K)hK6QsX#DI1
z9u627B;}u(kCGy9+(%kM%?q2ZAC=m8_GXp_Nzd=k`S%^)t@uvDcNvQ-@6(1ZEY(jM
zx=X+k)C3MbRa_7RFQ9rz8EJwB5rFv`i*tzqdPVCX=&1OkI7aq!QpQ-{$JjPTA`E<<
zWYOQ2oRuBlZTNOEwu(`%tSO{3-X=eW<{^RX1}ey{o{7cspnO02b>um(4`Tc~BlLW2
z1|FLTeWLWDl{VBk?)YxTcTmY2Ensa!tJ6Z=m6-a@lS`AWllagk2m*Mvp9Y`u1L*VF
zJhFO%$F>ZzXbQ0ql?65*3mno>btz-?=T_JW!=#;)c@)0NmG0Ud-);CV2P=v{pfrx_
z@1U5PY&w#u0?5erBDF-*N*~Y9OZfp7m-8S4&68&2P7PD}Kjz~xbW7yz@!K3C*eaca
zLMw-POnGCM;l|HXyW_hF-#*5!S$KTClSQ?KCFMg~66jXx1)I|5NCXFW1f8!#;Tsm;^^|&XsMKx;-fyr7OTz3zhZ4-hR^?ep73iVv|yKs2#Z+*P~kLJ?f^qks()-QH^
zZ-H+Y@Bgi-DU9`5_a`0Af&_=}T^S!{@+~iJC%LdfWk;F2dO)2=%H=rrcvHEsE(wQa6$5m
zOUO&I5`hy2_gTx*avzvBnl5Y_R5Itv5HJBNdCI->U}9Y+Rk!T;Zp1gjyuRNhO${xr
z!A&ieqi^)8Sc8pJKyr`)0k{bi3NxBt{qIn
z@JN&zq6#uhEYlHTHUZ?u`aA?Z%wLcRJUfpAsRUzN5^X0f-G8{_yBS~iAIo+gdhAs7
z-KS5>*sYW7q+>E+PJxe=z~h3hRbtc=X;_`Xe!Rv)pEF5mg5noqIuM-V&M_93qfsEa
zD^(V0(MbE$6U!~s5dNFX;2F7db0C*EH3m4;
zFw~~QqJ0sQph#AI`nK24JH8w6jbeOPH#ARQbc|cZ0p`!G{`yxs^f_xwji!y-fD_}w
zf8JC%vnVFlGc^JCNlvhuob13!Xs>PnAkWy|}8(&67zKje<
zR&n5T(V;Sz&|nvRNOiyH^e51i*hJ6Q0fe}jB-6b5H~VtCr6X;e{R!KB*`C1U_-NDj
zY|WtiF}!#l)fQu8RGdc_ndN7jW_;W2HeRs6YJ0ykM;{t|8&V`ZaC{NWV3^mauR==~
z*;&JcgGKbReiJ3|IuOv7>id%MvTrn&S{Rn*S*qr)ODkPL)-F-~zpf}ApON9-3-Qf1
z1-?|~pT7~}`>(BkWj#Ls!4_Q
zemu>i&7?aOa9uEY`-+}ro^5~MdZ$)O^TdQ^yRV80*~UV@_!dg%zUXX2&hs`IzQ99?
zuVD9p@y$EAe(~Mc4?WD0H*8ul;nx6N4h(BxnzBoJHk?6&1s$|hg#x7jXt%0ew9H7o
z`GswKv+_S#|pWsY1^!}sfN9KlDPf?EFZsW#sg$6YXr=Rc#3?Oz7GXdwXD
zd;j)gqb0n~KR#n%?s*mPq*>sxSh!P6)0njJXYZJck39`o*&(iA9n_efdmHe}*MlOm
z|Fys|7mPRKTNNE)5d$qW;}1{-8-;fmP#rMri9clUp`%k>vqPs?wTn?_y7ERHd3z<>
z^`k+=jLm_!ECoem77Zc%|GP%}tW-aSN`3hIfLH!TxM{q$UO*9bi7K%#nsFa_w?aOB
z_>yk$eE@&oVP1U`N!9-~oM&3;HdPP#X@M9ni)`(0gf
zuvZsa48XRNx7{tn;VQ)7F5G337N%C}rOQT8i)0weX+frFp(TZZNE&K+oT-+SvJQ;Isc3$1DHh_)vlExoSnF#*}#h=kPc6?*}%+MC51j|m$Nn(?JKs4Ti-Fz(YQSS)2x)xJk=Jy=Eoq@_{Xpui5M
z7V3kIU(#Jx&Na2`T``8qvFk87F&(aNh`bRaBi`Wmz6NGgu0<@JwHO~C
z$LQF2+(VuN*3$rd%c7qV3uk~lD2
zDq`EkPp)|zEyqPyjtUq>Wtql4dhPiSGIikhsG7Ifkvu^yAy)LtZ(7
zNi4&MpFWJYENd$*@aHGDcJX^h4Q1t&T^sih>o!DsT>I~D_3Qoa%oT(1B{kcqDGUZ%
zXtmUuXivFbYco&bq;UfAx%#`FqmFw0?o2_IisEza`3_go?;m-$SS+zz1HM*nSo?$)
zIUL5^jX>Am1Pt+!iZYj((-1HC@GIJ+
z3QjdPuB@+5(3N($#n#F|^WfC-t_jC$;?d5vlkW86tMZNKk&>CUeC02%p=Tpj=rW7<
z{odM`>=^z|OB^XVk86)Cr3a~|8l)c*{3Q5R%o`Zz2vGZ6NI9)@
zzIb2rEi_Jv%1h`c{rX9gTXD=>JW{*ezHtI5Mm5Z3M5hV#OS
zHBe6ix2A+8iY(W#M*FHBWgc5)6Ko26(?luAvKh8Jw%TxIu8gRmZ?=tCU&=o|IpQw2
z^POI>fqZ`g`0(>1F3#)5RO75wQDbYyx65F;f$`9TB~%%-yH_sfAd0_qz#=s<57gKJ
zw_14z7~0I2+x7d3n{L6@HX~+YzR-{C;9QO)?0yPu{@9UTak_HB*xi~#*=P93@!~{{
zgZ$7Y-D$_y1&4j9jbC2`T)TqUS)s3*TTx)&H~Is|n_eN_g9An?GhKHd+kS+&MKZEz
zc1<<7z5NH=VKJJs-)UDh;aeix*sa}mWj4^uq1lsoa+zgt->!HT8oUiM$r1UA-Q5%i
z*fb~4_LY%rCe80<$ytOON=Gk)Ko(VMAIY<_+%rN~7dmUB^|578UFD@HbF&bnz=^Br
z#&@4A#$ZrAro4v9ac+tLg^9!t)pY=#nUvE{n|+Iz?zN+>VU{-#>a4
z4S*RTY*#k~^5um)Mse8^9My<#XVuhwryPtBOA4PHsH%7!5C_Yb>6!r2Qaok>TlJEH%-b-@!2(9*N+z4S3%{L#qVd&B|I%ngt9b#J0}W*
zq{I|$8x`7PV-?jwo0}pKZC%-?93p=sNcq-;MWlHEv%mbf}&GA&Q5t
zSeR@Ep=8Cx;Anm|c_4XUk6G~l#S|h2)h&|(pd;g0VXd2GWyCzv6(Ztm+|oKN+$EJ|
z$iyN7de3~S!n!-VwL6ZKgLuYnQUCJWth2>LKZ@`rrFi-t8J@8Gsq~Iubr)E1%Xrjy
z9tggYHEAH_NYe^Muu2J`L~E#PLH?m7R=`926u>gm?$UszHP9|c;~CugIDqP9VDTi~
zew@4h!~*#J{P~5W`g05lkaEppd~?z&5lT~5k!a@76uZ^R9*y|kI5Fx9`=H>9vWKrx
zjzEJ@H7K-9f3p?wXe;Qh-$)B1LE84W@-^?)JQB6{ty1Jl|P-
z9|uACp-usdcR*ZTdahTH1Vpv?(u@Wx0V-(AdOT9Od5*%+Z;$s$6B5B_$FV-9U@S1evbgYBr}SNlWOmyW??u
z2jhz}UuBt-g1SaUp`G8cA`*aLrzO%f#}x;ki}_Exq{o$>i*zWJm(@>zG=|r<%8mSY
zw+1YlvrW4|2EA-MKN_$|1-fPN3T_DMagq0H%u4TcC2YXT(ZhfwGo=RctJveAm1<11
zeYHYsp5gKX&&Av)UD{K~=MZ1wFZXYHUSB>~({uUnZmk_(7RA@jaeTL#4{WaZqRe7^
zsf4_~enur3l>}ekS8iQ&cp@y%
zt3%9?43$V*rqrYp>;Z`}%lOHO(G7+|CK+zKH1$&3)
zDsrF`teQ+Pymit$Awij^2xYGXE1@uD4yMQmA*mHQZJ`#gjDaE}|A(@_C@4xJt1FR)M
z7KXR``aW}P24hEKJDg|{uN7;}Xc4V9T$^#mwr$&U*?Z32`jeACoqlFsB`3|&SEv6v
zRriKCv?lA+h4&g4yU?Sgu(3+||IsRRxtj*U?}TIHC;Q$=aA@q=m*rd+D00uuY|+k4
zPVL^a|4sL3f!cEp?t@uBP0AGsAw~qxC{P|9eRJ*Oi2Jw)YiB*&DBMHC%ecll-RFFL
zm4c4kZzppYUw2mu!maO9r&+cGkk3v{78kQIwMXxE8Zfj9h6NZoe1KzLgYAa)Fy|PK
z&b)4kr%5P?Z(xoCF-0phj1)NT&J%i$BOILacE(W{bOA?(-v`cIZkLmHUhO>N#0h6f
zrq6aOUO*0=7b`g6o&)Yt2om(7D#zF{
z&`0{fJkHxeX9nA}SjIVZqMIGM=-7U6b$%fJ=+mHZXpbyrj!@<7iWMt1w6?Z>QO;X~
zAn?kv7%diym33kwk-&Pfa@1$OEZ{ZixhB1qe6mMh(sR6zcLPZuB>m@K|N7UrrQCPy
z*sRjM?A+kQaX-J?QOAfm2hOfsxpGT$bMu$wyhW^A`O3MrslxZ)|Ni&a3Wb6VMPS}w
zh@m|)R%V5rNvG3w>({UUYISw>b^z3)g3**rCKa09>EcZh`&^G|7z8}i0epD;`0-C%
zzI^$ry!PIyN|E9BGE7{TaSV+?+uuHLjyq+}W-^(^b?erBOZaZY6CGZtHE=mO?*S
z9HI>+aHjk12suI)f$Yp`5^7A5X>TlNh5|4=s~Rx54-0z_$5dlu<03gd;o6iG%ac=~
zlf9AHnKAeXgRs!@DHg?%lW)T~XVt=YYCIkv*ModfUQ+ljk<;VE7d(4C5nnJy%pd90
z9-Uj`Fe44%BS(%LJ!j6GPuJActTVA0D};r}@7P$*UPCni8`I*0Q>RXS?f(7yH{|`2
z+^;y1ivt6fr&1BFk)jle2bUA8ohH<&CLeV0?Afzdxm@mpi|-4VK{zaeS>EK#8L=v{
z+EJrMjh#Jv_Gg6e+8*YM82iD=lPACW;K76IaxZ82a(&DW&(u1~7w>RFp0a$<%J-$=
z3xi_^9aoKFgf8FPnTE#4WBh@*4L&?
znR3pQADBgug^EE!y*f>!?27SV!)Xw!nsRut72s=8*z%q)G3~?m@82Jm^xxO7U%!fq
z{cxYv8DcSS-n{w3cSSavT`X{KnL&Q_q5n;~VrcU*y+NQ{VHz_sEeW
z{}H~=!qzKM3hk3RC$UHoMV>Wn+O!|)GzfS`LDlK(4h5^DE@t#x4V}dxppyU%2!Mt>
zdepjXhfz+Yd~E~jLteaVV^IdLWlFy^KdYXFj(02NsaeH)^XAP@|M|~ZE=r9i$D;39(sGF4ngT!ja;Y+127&O!=s=7ly_&;2{c=2*O
z7pC>nG_JSlQ7QQm3wFx;iZPme<)fBdEAj~$7<2MU{
z@7a!`3|z|;Q|WvvmC`R8dGs9WfR5XJSyd4pT$B&R3EkQfSRdiUYK8$}H8LsD(9oc}
z1vgop0Y4&sR=(py`3~{L`*GRrnk=W+9J2z6201jrhC&0lR8SPli+O-YfbnH|Xkb2{
z$20{1JoVYBv0`SChxaf&0-l0pb>Mi?*2xPL090dT^o#ql8Tj|PAXLjrJJl<^nOd#?=5Djv6kr*>Y1
z30$-{kh=9ckU@19z*yU5TwYBSYRnKvnbtLYnDu|j4Sm;zF4Te&%dZ@Ysq;*tuwsI~V)g#{3)i%nu
z%FjOm1E3BX>WtjuMR~}Nb1cNP9PPV=94m$oAO7ou2M_*5oXu|Ed8E`nlw9KO39`HJ
zS>d~Gh;KCCrlzK4%JUpP-|`UUesg{MC#h|P~WVHP&b{)ZxLI}K%;!A^-%
zFLMm}Z=W1;BqYpO*fG9Cd}VRC!mU%{mTT0a5Ehd{5~#>_#;$5DG(g6A)Kp{RF#xdl
zF=b(3?DUBNu^{oB_c+bg8n*@IMgF2j>Vjt+yV^Q4#%aMa^hYbnlk6DZA--bi|FLsE
zD(6n=qy|My&AZ#%Zz`!m1?;UlqFmj50Yw#-_qM<(wraz}DIW&6T!eVwocy?d
z*R`Shz4rM%{92Z~3OVd5u+U3)18IhzHd_YYHz6Jw6R(Menu&c6?%L7m)5+(o77y}{2qQI1irQ`v~W3}
zm^xthQR-&xO8D%joI29-aBW@OzG}6PUKs5$AqN)ZwMyF^
ze*b`9=bJj>lJV4|qQgJG+O^>90w6q-O-
z=wV(vZ1a2geNKKq&T_;tqbpa6pgeaPYmryih-|C~%Q2WiS;JPugqm2eSWwy3dQjVK
zTI+zL4zA$g`}_MbkKEsF9ICD!em~-O%=dF>jk1xp8)F3F&JjB1<45_N34-i=pwpJ4
zi^EpCUnsy@3&ee)67ICSSlRco0Q
z-px91huNb%*Si&97?
zTRt?Ih^aaSfg-b4g;B->R=KJS{|@leZb@cQPnn*o>X$J7vG96+Rc!D(KIixFyKSK(
z=NE1<2(EUCx_6bCWRqW&2c=cfQ|>xF@Tx$cicU-u-@NTL_8Ay#Of(!=mw(QmbEyD+UA_K&#I>*d03N6#A5%
z;ywialaIsi9>4!@Z>*5#o5Tj$3;<#hg8NKrDP^>KqYe||C$xLh4sZ&|gYDIF=Xz~9
zz$*7@t%9u9vlJrAy$QIY5CUEEm4s&=&&xudi*>4y0IJ^b$Q`}v|U2#Xc?FGNU!=uVXcfa*wnmMrFm
z%PR2ME{Or=<%Dl7jxF0i;;vZP)EEfwljx0S;2ogWffA)w4NC6-9W^y2tr<^oaJk?A
z&Fq<-on?;ea(3pQBuV_||A6o9`3wF|D2yzJqXT>_2(Wxta`%4F4B0RVo)bmp
z`ksr0Hfuo|fE;Sq{O`XifZ2dTCwYQSpkKh3i#eaqGrw3Y-i2>u>-aLhF9?Nn*?PHx
zbTI1aUBT1GSQS|CLJJA)XEj=OAYMrjEV{_X?vaFl*M}Osgi62PXWij&(6&&jk4U)*
z#|^rGe!`i}uN>!J!dL07_9*^aCJX#gB
z`@#|PuNd$cXIy0ZG`<|4#iZG6a;&S>Dyip~5mSe4aCFal9836~cDv1bMEw%PQe@w1
zwQ3hXoi>)sWxfmRhqxlIn38c6i$#fOyWPrqy?%gi;3DD~n?eBd2hYt!S@Piw?y70+
z*~@M_!FCh*TGRBA+Sdz9%$u_!FYct%X$eRjg|j^>V^TRe2_f8?)M_>9bUOC`AU8E*
zU;xf16e|g?3BK1);)~-3zoek=@$Pmz9V6@Z`#sC($1ec4H*t?Hw|L#Z_d;ny4%mr`)V|R>1A#-g*|1$X
z0)#z2I9iZnfS6*ELdSs?+(x4zv)PPgOfH4UdluJM5K<~ueh{|#X7D|K65r8iB=h-P
zl&#g#rzMdkwwI-y3f0Ws>=Nef?d@7vBX&{qrp+=D>^M_s@15G4
zgdlUw(b18ZrJaHy*Aw6$-w^jj!$=hJ5aK2*DAEnWw58OoDr#M7H%w{
z0XeqyW7%Rsuijrqcq--7E-!n(KE630viP#f%*;$@dU`qvr_TztqKJ6Ju^m6!`hO6`
zTUc12KW>f^zM^KIZ3b*dIdGRazvBdXMU%L3k6rPC<&RhjD8O_eskZ
zkw8N=L_Z?-hA)^@o|A*-CeUS$r{E-?+BrE-|J0DhC%flI+{!DK7z^w{Ivz^^nAAuu
z_V@R3!@-F~HL{QT`1hJ}#pyH!Q#37`4>lU8Rl!f1RT!^u&CN}XovKz5!O`iNX9=a9w5-OE!HEBVb92*ekQz_91i6Xifr@Jbhlhtb
zd`Yv`!fi(*ONJ6tNqO=U0%Y9tfTjTa_&IVuj
z-~gk$9%E~3E8^>l!;dfGiv2W^ZtAH2RTSsRwq2+0V;=1z*iT_=3T#HNJAiiAqQb
zNK?mU_Oxv@+a{ZRFc7|fEB2+eAKIU)?Ng3tD2jvP7Pf~#M$oxnu1U;W;JZ4JnbH%n
z&_+2Mq@_7tAP9KECOs$}VR5dW-IP7^kf>{zD(&$d{LqGFK6}!e!dIGE8d#cI75hV!
z?f(9rvHvZ;kHu)aoFJoR2)GgNuq=>qo!y=KS@)7a@nnJOCuXqc?hRuVqwx6b8cr3^
z;i2(2&LIkbRulsTA$+xQ7pI1pif09LMeM+{AmqZe_m=P#rC45GuIZb`OG2n6ZN~GB
z`CH=)wrwZ}7ecR9f9tU-b^c8pfD&D6+}TXu@GUoVqBa05wKa#l`fy9Wai^x3q#K|k
zC{%Y}0jO`);DY1H4c)y6!peNr!5sIzY0yGB3mrM7^JWjfjO|ry+VpJm4**`E8+-<11^EA7
z#CM1b9Pi`M=F`K&!+~h5PQ^HMj&7)3@AC5UXaocrXu`Z+n*e@Fw4rop>vt70ypF7Mr);{=~V
zJC1?-!4c68(I<`Zqo+qECnq~&V`Dzu(bjLCrsZRs0t>|qJB2^@1B+xh|8{zM>VQX~
zrh;>YKqq|vNY?*PNoo9;`Wa3Cr>pAPD*o?4JMc6(z6eDdeD$73@4hO&w8`wllFNvS
zjUk))`t0mXLEMk=L1Zu8_};2U*V&2ve;ca4QyrnL_hp~|m!&`z+)rO|;|H*NdNqOO
z6>LU?alrS3YW-f{>-S*+H!xNGV)zzU3SCQA_Wnsg12`Av9RsaWnNU|wIkFs@5@thT
z>x$yN3NzRkJ{aCsa+D)>)L@ajAipQzopMkO^s4BCcA<8G2H#
wLTtYcHHdR$1H1Tap<(Rb4U2i-{Ch9|0Ae6OZS6N?h5!Hn07*qoM6N<$f+7tEvj6}9
diff --git a/mkdocs.yml b/mkdocs.yml
new file mode 100644
index 000000000..85801fea5
--- /dev/null
+++ b/mkdocs.yml
@@ -0,0 +1,33 @@
+site_name: Solaar Documentation
+site_description: Linux Device Manager for Logitech Unifying Receivers and Devices.
+site_author: pwr-Solaar
+repo_url: https://github.com/pwr-Solaar/Solaar
+repo_name: Solaar
+logo: img/favicon.png
+theme:
+ name: readthedocs
+docs_dir: docs
+nav:
+ - Solaar: index.md
+ - Capabilities: capabilities.md
+ - Debian: debian.md
+ - Devices: devices.md
+ - Features: features.md
+ - Translation: i18n.md
+ - Implementation: implementation.md
+ - Installation: installation.md
+ - Rules: rules.md
+ - Usage: usage.md
+
+ - Developer Documentation: reference/developer_documentation.md
+
+plugins:
+ - search
+ - mkdocstrings:
+ handlers:
+ python:
+ setup_commands:
+ - python -m pip install .
+ - mermaid2
+markdown_extensions:
+ - pymdownx.superfences
- {{ site.title | default: site.github.repository_name }}