From 6d9ef4107f381ec1893429135b6d9737420ed308 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:06:01 +0100 Subject: [PATCH 01/13] Add mkdocs --- CHANGELOG.md | 2 ++ pyproject.toml | 2 +- requirements-mkdocs.txt | 16 ++++++++++++++++ src/compas_invocations2/mkdocs.py | 18 ++++++++++++++++++ tasks.py | 4 ++-- 5 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 requirements-mkdocs.txt create mode 100644 src/compas_invocations2/mkdocs.py diff --git a/CHANGELOG.md b/CHANGELOG.md index d713049..ee3960e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added +* Added support for `Mkdocs` documentation generation, using `mkdocs.docs` task. (`Mkdocs` is an optional dependency at the moment, but may become a required dependency in the future). + ### Changed ### Removed diff --git a/pyproject.toml b/pyproject.toml index 7dc7745..82e37a6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,7 @@ zip-safe = false [tool.setuptools.dynamic] version = { attr = "compas_invocations2.__version__" } dependencies = { file = "requirements.txt" } -optional-dependencies = { dev = { file = "requirements-dev.txt" } } +optional-dependencies = { dev = { file = "requirements-dev.txt" }, mkdocs = { file = "requirements-mkdocs.txt" } } [tool.setuptools.packages.find] where = ["src"] diff --git a/requirements-mkdocs.txt b/requirements-mkdocs.txt new file mode 100644 index 0000000..42585b8 --- /dev/null +++ b/requirements-mkdocs.txt @@ -0,0 +1,16 @@ +markdown-callouts >=0.4 +markdown-exec >=1.8 +mike +mkdocs >=1.6 +mkdocs-autorefs >=1.4 +mkdocs-coverage >=1.0 +mkdocs-git-revision-date-localized-plugin >=1.2 +mkdocs-llmstxt >=0.2 +mkdocs-material >=9.5 +mkdocs-minify-plugin >=0.8 +mkdocs-redirects >=1.2 +mkdocs-section-index >=0.3 +mkdocs-mermaid2-plugin +mkdocstrings[python] +pydantic >=2.10 +tomli >=2.0; python_version < '3.11' diff --git a/src/compas_invocations2/mkdocs.py b/src/compas_invocations2/mkdocs.py new file mode 100644 index 0000000..b379ec8 --- /dev/null +++ b/src/compas_invocations2/mkdocs.py @@ -0,0 +1,18 @@ +import invoke + +from compas_invocations2.console import chdir + + +@invoke.task( + help={ + "clean": "True to clean the site directory before building, otherwise False.", + "verbose": "True to nicely format the output, otherwise False.", + } +) +def docs(ctx, clean=False, verbose=False): + """Builds the HTML documentation based on mkdocs.""" + clean_flag = "--clean" if clean else "" + verbose_flag = "--verbose" if verbose else "" + + with chdir(ctx.base_folder): + ctx.run("mkdocs build {} {} -d dist/docs".format(clean_flag, verbose_flag)) diff --git a/tasks.py b/tasks.py index cd33979..23cd851 100644 --- a/tasks.py +++ b/tasks.py @@ -6,16 +6,16 @@ from compas_invocations2 import build from compas_invocations2 import docs +from compas_invocations2 import mkdocs from compas_invocations2 import style from compas_invocations2 import tests ns = Collection( docs.help, + mkdocs.docs, style.check, style.lint, style.format, - docs.docs, - docs.linkcheck, tests.test, tests.testdocs, tests.testcodeblocks, From 169baefa0cc066de6023fe5dae46b12967f91a48 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:27:21 +0100 Subject: [PATCH 02/13] Update license --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index ac4d88e..a344364 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -ETH Zurich +Copyright (c) 2026 COMPAS Association Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 45b63932586d1c5ad6db52a611bd9a0fb090ba0f Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:43:03 +0100 Subject: [PATCH 03/13] bump setuptools ver --- pyproject.toml | 2 +- src/compas_invocations2/__init__.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 82e37a6..42d95e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,5 +1,5 @@ [build-system] -requires = ["setuptools>=66.0"] +requires = ["setuptools>=68.0"] build-backend = "setuptools.build_meta" # ============================================================================ diff --git a/src/compas_invocations2/__init__.py b/src/compas_invocations2/__init__.py index 4776fa1..5f2af4d 100644 --- a/src/compas_invocations2/__init__.py +++ b/src/compas_invocations2/__init__.py @@ -1,5 +1,5 @@ __author__ = ["Li Chen"] -__copyright__ = "ETH Zurich" +__copyright__ = "COMPAS Association" __license__ = "MIT License" __email__ = "li.chen@arch.ethz.ch" __version__ = "0.7.0" From 47931e43b82dbac8b13c62a6e40798f255400a42 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:43:21 +0100 Subject: [PATCH 04/13] add author --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 42d95e4..a6da079 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,6 +12,7 @@ description = "A collection of reusable pyinvoke tasks." keywords = [] authors = [ { name = "Li Chen", email = "li.chen@arch.ethz.ch" }, + { name = "Gonzalo Casas", email = "casas@arch.ethz.ch" }, ] license = { file = "LICENSE" } readme = "README.md" From a8488ad2c7d7b203a71c6254dacdfdd8a7308e54 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:50:24 +0100 Subject: [PATCH 05/13] Add static assets to mkdocs migration --- docs/_logo/compas_logo_white_transparent.png | Bin 0 -> 7852 bytes docs/_logo/favicon.ico | Bin 0 -> 4856 bytes docs/assets/stylesheets/custom.css | 5 +++++ docs/examples/PLACEHOLDER | 0 4 files changed, 5 insertions(+) create mode 100644 docs/_logo/compas_logo_white_transparent.png create mode 100644 docs/_logo/favicon.ico create mode 100644 docs/assets/stylesheets/custom.css delete mode 100644 docs/examples/PLACEHOLDER diff --git a/docs/_logo/compas_logo_white_transparent.png b/docs/_logo/compas_logo_white_transparent.png new file mode 100644 index 0000000000000000000000000000000000000000..5dd158c84d0aeaebe246993a3a6090bc9803e299 GIT binary patch literal 7852 zcmV;d9#i3oP)s0Nakg zcm4YmFTmr`XZ4ByOGM0XNyt%>?T(ziI5XhQ1Z8<(FYIP_JnlYAL_!ks^yG+8jaaXy zEQ|%uh^T8s*hc7y2}nX7mklD^91-qZL_3scM9?*RfhR^F2{}ADaJ~EUa?+BF&nqJ6 z``w?-gk@PYNyz@$Ai_1`y_mE#aq)x*x+3+~UP(gs!=ZRTOk9?^@Qn1-6-m_2Bq6(T z4HP8tx?)6qOESMzBq7_A0XK+%liBQ_Cq&Tqq$#e!Bq0x{*d0srG{?#-Vs@uqdH_kt zr`fRYeWwVs-XpUIGl@^RW?B+ifoeMAzn zkTFjIKe2ZRHR#5YTVx0U)5UXZNrK+7b|G(&itu^ja`f@aK92c?{TQ+C`MxjALXE=( z8yWFB`ks-Y(EZc}nTj)Lj>JSTa58olaMoHEH#yR_{x6qK+Uo%nGyCi(?0K8M9_<8 zEkZ7VFB9C?gdQ3JuaT+a(4UYYR6W7HM`P(i&XHbtOf%XTgJc9;4sE znWYMO3UBleM7*o@oLZ70g1%wAhV~f=@~KC<-)JmR$Xi5AV^of3_PuX2!u^&?jtFe5 zdHluo&Px+=$v9)-2lfI^_#;CEJ;t=))9zl282&6p$Qk2!q<1Nkxqo!bwMX6{4y{n8^lC%>BFC%`4>^YZ#0-5Oa};t&uk`AJ?`J~j z>BT$53Y!gc6LP5W@T$W37Q_~LZy_wR2c*8uV%$6@As4{+0N4G2^ukSmYbVB`Km_f( zfqz28+<3mOcjhAG3je_ZuSf+*X7n=HAYu+tPjVukZ=QqKy2Ag|1;#sSbu2cHS42GW-ta+62dterI=$BatIMGA`Gtw*QuD--T6y>J{i(r`K(XT zi8(eQ`xfyt(ke&osBmD5R45>nqY`sWLiR19nq zfn`5GvpC|()Aha+K{#g&J#vMgdE!}2+aKDcMXWsp+}xx|l%pO6Q*1`%H~UZT2d_IpAtnHyv{ z=8A~`%RF4mnyG|b;3v1%(!H$5jOm2B82NrvQsGa`_e{_LP9fwie#Urf6ETb*?>qMW zrli7;m@k+08xOTBYZNhzzh6~0^8Kc!0)9uFeJ)%v@|4t=LN+3Hoi7Am&UCeJ7VZ0n#$R=&A3nm%Bnni3FyN7H> zzF&+~xCe~{4|@$QFxQ~l(NFqLD?D@%h zVB_UbLN+;*T=?qY8cXAz@yzQ7l4*TRj$2~CHw21d4<%&RWp+PUN6@}4 zFN~LxryS`%bK(WDG+i3g&jg5=3nAni+%o^0eQOil+!DT5{y{RU`*_6NaaG~j#P+=& z*)?-Ta&8SH2mT6l?N=nCE6oy|#x)0+*DN-^d*li?lR7!KhVe+aUipzE;vwAN=KS(% zV*3>GHEs#P??}$Ap@i7y$Z*BFRz11kI$rkX@9Z;+N;J7@fi%(11O;5=L4zk%=Z z%sLlLXt)OcbU6Pj9vq9ldgL420za0Vw$?Xec&&p?lPr*X#5t(t1`myBlU*x2OTN}R{GvV5aE63k|f-?@UVh#a?>1g9*V zu0qanEBrf>mwG5A!}FY-@;MaP_3G&z4W~jMmi&N&lhJjITsoZlM5-V|$*`MqEa^9i zE2Pp4WvocDCE)U`u5hq^T!eg$TLjl75qv@jgN?a%$ME4w$?#x?H!OQUC=EICtp9`G;G9x(l2*v7n+@PI(krJ*BNPlzSon(F zb8E0`B)rUbE`SX2{QrgD&C?BUP>hu|LM{lKUGV~GxvS!cID{jjbCvaOMFGw>&%f1yJ)%JaZ3YKGkgYOO+h?4(m=Y*&S>ksRlK`xk6c=Q z-|&o>CV!w`E%F61w+rR@bE2~N?gQ?*yli^qOP2o*GUOfngGZI+Ew6kq~|f#aoy?#*S7NP%C@_K zD;%zy^_2IgBh*Viq&Rc!kPmQfM``)HegEbgi~G0jG8$1I9ZEIeSu_sUKKnaDy8+VOuxMKWA4nw+}>LLwmfio zY@U4+xGX-8ymcGKwXNGQu2kOh@!YkC+`LlWyc%%rb4Sto89z^5fzBPZ#c#SFp*)#I zdD=FdneX%W*gWGd>ek&SuyMHm$$JmExz+@6{n3X%zEqaM(6r)Io4P`E9fjp@@%3EK z9k&)`igh~5SKY}ymZ?&f=`KSxch~+BU z`Oa#1)z_&WxnKSLJTpyZ%myj%d-NMokC|@BHhoVWs2oGN!7eRO8LlXRyz3en2fHMN z-!fgYgi3i{(fMglYjLe?En@LpmhCi=J41UBn{s4<%At9tQDPXZ36gLBtvD+^cIdm zGgf{>SHgjwmZI_1QbcgXv|Q3A$f9ZE3$iFI%HOtrdOp|Hacvv#>Nu_C`^#)g*TpmC z#bYt6W33Rj&$UqAC-hNU{D#`$J~1`GArI~E`sq4drgg69?jas?rH^~Wx$zaZbVHBm zQr%P*-yO1B#8i|P-_>k`a=2@QHqFj6;`qEKo}oz}nk`xLUq0z*Au2@+F;)UxapW%UVG?ur#ft&UDFP?V&)#?qdBx|{ePN<^3@~PigTuD zt>S#P!^+~iF-$j|!*)9ATu@1lyc3sQ8@>@PtTH5CfAAq;WbDLwTUC9pAN$r~bzL8^e;}UjM#0 z>_>i%jsJ?&$;zQzb3#)GI(y_yaUpHWow?E=t>EuSMQb{~W1GIGbT8KA7)RkyKGR*_ zZV)lQ-Cb{qW^^C5;+zY1*3IFzsx|gwbPM(K{3&gOlx~K*g2eT z88+W;mP@+qjxl6+NmKs68E^N(TkLkJShM4+)|})bs#Y}5CYp6+YR(k=S&vj($!p;;v1gX1h9=Wy}HuZkq(Vc5n~huAHm!F_j( zp_p{DRe)>XU>AqIw&|!^b5auWFnmroxl-f4J4PR7*M^dCvl1`(+odA0BMJFD8FB6w zQQ^KjhQaJ!m^04O)Dk-rwQ%&>K*p2n8FvVB~Nyw+Moo=!Tk_bVKi1Xa?!LP)zYeQl2 z-L=GFtJY;FA@@^Y7lRyAC7W8HLuv4{OU05<{l0&Z@@{ouJKeN|-6E!WxFtV82U67NjK8ktxpkXN77opT4JWw}^y4D(w6=Wtd`& zj<$1bQjcucyY}rCk?>Dx@!h5DQjsand4|1dt?6O3N!((>HhoX>l8#5s`qBbrigOy+ z3%OR_I9Hw*1Ge$hr*?}-grQ_zX@N9WZUa9DglN*nWQucQA*S>_iEbL!l@=&doYTP1 zLe`9vH8+ld4EyvwO^}i#&QW5Q7HG~h3Yx8Z9^q#pH;RkoigRM1B;0Nh3IEtMx^vy7 zLhZ2zcOlQwbDcBJZV?H8+_U_&Kw2&R(j(W3i(D{2^SZS7u8-X!5`I{E9JWTt|1ACd z_rZtS3>RDC8b4;pv{KHm(-9l&#v!Gb5+!_KcBvR@O_g*nb*y*SnmWJQF&ZKNquE0t zzaZm5+gQ(>I37xlygcn5N5_QNEh6E@4I<7V{*4Q|>w@|06{)u+adbqQdi#%%k3%#y zy>hNN$0r#gxWDix;*`E8PHf|_PjP|t?q{(?!&5kuv)dupv!1#f#1A zsG)p8I)ka|ajrbCHh=kd$A4%x!Oj`qye^Raetk3cZV@3k*C01z6e1u6VuAVOiv7M? zW6x6LigSL-arRr=w#Q%i<%0oyV_Yxc7Wi+VYyV)m`Jk4<25F2!#QQ%n{mni8BNTK zYr=L;x$?aF_=CQjUB7&BAR*1`4db=Oi3Egq;ugyDei{Du2|31b@*G!MCFV`YI+vka zf84nnN1u=zbkQ@$ybeJY=(>qSA0aKkLU~?iCwnR#Zfw1B7U;T(#1s_D^Q?tjDQ^^N z+9oaTPmGNwkKGWo-s&Ip=-`x)AJLiDp@KuwR8V4ULe)8KXV+^bpWA6dYhH)wl~a$L zSOOdL!%wx4wR30%{+(W03n7uvQU|!^(8LJG^qSSs9}r?_kZ>?tH~9rp;L7s6bJW-+ z&T~bxfFuzP+f+@igjk$YD$hGvmab)t#}w$+{XXM=tei7mwACHU*iUFlWJpGjF$l4o zF-KQ_UpZsp4%v-S+bX@me`HL}c)esb(tQ%cX|UT5%7qZ2nWgf)vl<-IBZE|GjY<1} ze=&zlDqu*-1>z+`{3Rhb5e!jpGxXNPJI;8}hwhJDDGP9gfAi!K`0DwZhdh%^>X>N= zyTmlqK3}Esye9@sgAEmO%~6gZ3qn1V5GK|u(i5ktuDGcPXJUs~zM7$T(hf55hYES{ z1v~gim;jLizc2F@F{hRgcv2&Ip!$w-s)Bi>z`vM35ym%CD$jdmV0mnWT%iwHE0yP+ zqX7QEJ(TW=<%oDq6v+E`T~c&G^QClY5{WUmL7yhbx;F;BkQ?;9@&(HupC#7I2DkdHI#(-X zkXA?Q!T!wj`zj|AA*j&Dfvb9Ba1-(iZc|EWf2G9I$g$tp!Qd3*?IL7wn^(Rhnb?Wt zu))p2b&JEan5&Rqa9b4dg_L+cu?$M|4z6b$EmT(_gS0~0l~LyWL}Je5xa|^J;uxgj zL&)IPD<=~>F=sZo<@S2OLucko$Tbqix|ysX#vC1j9Z)nz&1JtaT+&JM0adz9;3mK$x|gKLuf+6haTnkd0Tb(o6f($4L z_L-C-C^0@8q%(5yP=nOn#_<{_8AHe*t&wXI`R^n#C&t5w*mXbVZ;TM=G?tKkjF%ya zIWZ2tL>zQne8^Zr26-@_JX|MimKv=7e8-i5S9c&3ck4gbXrXcF8JYNMcU-z^91+V1n3(sf28tU#^~P5HY8D=7g3E ze+9iBQB4w~%2!&+Jpom&i*lJzg^r2N~iM@#U2^ z+!3*eA$}plz6bRYn|(;?otH%k{Eb_x+Ah8^gLwWq2pRUyD&Jx@z4I-}vprXGq(S}? z;M$*jX1gBCULlwEBs7C=ko(3;yPX z4>3-yCcw3WGFKtPUTD6@&4w$)c~X%CJv9X)uJ42qFi1jxf`~oSr1MXoT+Uvg04wp=#XrX_t_9uz#tn9nh3C2vlJo2 z-qd#41#$>i$Qb&O}~saV1)gMW8=5BZKp27RG9h78>a0!j(KG->}Ge= zme;5`?Lhj9-Fob7cWe)iv8|eOnB3C!#O0WTwe`q{ydahNc6Wpbz}Ikri11j5M&K{( z0~qRq|F6-Ju^+o1{yj$;yVwMK%ro*Ht7(fdEo<(PkI9e<5sRP`r%3`nU=3dDp)|Mi4YxD&&9Mgo2^l8FBy^~n9iI)+{=56BQ`X`X&BBq5(?gG{HC#Nm})8)mE0*)MDe zNfNRhIbwdNadcRo5%E^6WFFX+BxD^MM9>BCdv)i;9U|U(+G5O)BxH9?fXOw<^w#hL z8Ta0kdS5k3$bLzp9!3(cXOfV^ks*Snb<6#yOE$B!DAPG5s zHb}2+{)BxNPoIk#%%Tj~i_|R8I9#Zah>#@YWpOC>b0l#ti2nmA<`vwJUg1ap0000< KMNUMnLSTYD|Am_X literal 0 HcmV?d00001 diff --git a/docs/_logo/favicon.ico b/docs/_logo/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..381bd9414fc39233e98365aa1149bccf33b64f23 GIT binary patch literal 4856 zcmVKLZ*U+IBfRsybQWXdwQbLP>6pAqfylh#{fb6;Z(vMMVS~$e@S=j*ftg6;Uhf59&ghTmgWD0l;*T zI709Y^p6lP1rIRMx#05C~cW=H_Aw*bJ-5DT&Z2n+x)QHX^p z00esgV8|mQcmRZ%02D^@S3L16t`O%c004NIvOKvYIYoh62rY33S640`D9%Y2D-rV&neh&#Q1i z007~1e$oCcFS8neI|hJl{-P!B1ZZ9hpmq0)X0i`JwE&>$+E?>%_LC6RbVIkUx0b+_+BaR3cnT7Zv!AJxW zizFb)h!jyGOOZ85F;a?DAXP{m@;!0_IfqH8(HlgRxt7s3}k3K`kFu>>-2Q$QMFfPW!La{h336o>X zu_CMttHv6zR;&ZNiS=X8v3CR#fknUxHUxJ0uoBa_M6WNWeqIg~6QE69c9o#eyhGvpiOA@W-aonk<7r1(?fC{oI5N*U!4 zfg=2N-7=cNnjjOr{yriy6mMFgG#l znCF=fnQv8CDz++o6_Lscl}eQ+l^ZHARH>?_s@|##Rr6KLRFA1%Q+=*RRWnoLsR`7U zt5vFIcfW3@?wFpwUVxrVZ>QdQz32KIeJ}k~{cZZE^+ya? z2D1z#2HOnI7(B%_ac?{wFUQ;QQA1tBKtrWrm0_3Rgps+?Jfqb{jYbcQX~taRB;#$y zZN{S}1|}gUOHJxc?wV3fxuz+mJ4`!F$IZ;mqRrNsHJd##*D~ju=bP7?-?v~|cv>vB zsJ6IeNwVZxrdjT`yl#bBIa#GxRa#xMMy;K#CDyyGyQdMSxlWT#tDe?p!?5wT$+oGt z8L;Kp2HUQ-ZMJ=3XJQv;x5ci*?vuTfeY$;({XGW_huIFR9a(?@3)XSs8O^N5RyOM=TTmp(3=8^+zpz2r)C z^>JO{deZfso3oq3?Wo(Y?l$ge?uXo;%ru`Vo>?<<(8I_>;8Eq#KMS9gFl*neeosSB zfoHYnBQIkwkyowPu(zdms`p{<7e4kra-ZWq<2*OsGTvEV%s0Td$hXT+!*8Bnh2KMe zBmZRodjHV?r+_5^X9J0WL4jKW`}lf%A-|44I@@LTvf1rHjG(ze6+w@Jt%Bvjts!X0 z?2xS?_ve_-kiKB_KiJlZ$9G`c^=E@oNG)mWWaNo-3TIW8)$Hg0Ub-~8?KhvJ>$ z3*&nim@mj(aCxE5!t{lw7O5^0EIO7zOo&c6l<+|iDySBWCGrz@C5{St!X3hAA}`T4 z(TLbXTq+(;@<=L8dXnssyft|w#WSTW<++3>sgS%(4NTpeI-VAqb|7ssJvzNHgOZVu zaYCvgO_R1~>SyL=cFU|~g|hy|Zi}}s9+d~lYqOB71z9Z$wnC=pR9Yz4DhIM>Wmjgu z&56o6maCpC&F##y%G;1PobR9i?GnNg;gYtchD%p19a!eQtZF&3JaKv33gZ<8D~47E ztUS1iwkmDaPpj=$m#%)jCVEY4fnLGNg2A-`YwHVD3gv};>)hAvT~AmqS>Lr``i7kw zJ{5_It`yrBmlc25DBO7E8;5VoznR>Ww5hAaxn$2~(q`%A-YuS64wkBy=9dm`4cXeX z4c}I@?e+FW+b@^RDBHV(wnMq2zdX3SWv9u`%{xC-q*U}&`cyXV(%rRT*Z6MH?i+i& z_B8C(+grT%{XWUQ+f@NoP1R=AW&26{v-dx)iK^-Nmiuj8txj!m?Z*Ss1N{dh4z}01 z)YTo*JycSU)+_5r4#yw9{+;i4Ee$peRgIj+;v;ZGdF1K$3E%e~4LaI(jC-u%2h$&R z9cLXcYC@Xwnns&bn)_Q~Te?roKGD|d-g^8;+aC{{G(1^(O7m37Y1-+6)01cN&y1aw zoqc{T`P^XJqPBbIW6s}d4{z_f5Om?vMgNQEJG?v2T=KYd^0M3I6IZxbny)%vZR&LD zJpPl@Psh8QyPB@KTx+@RdcC!KX7}kEo;S|j^u2lU7XQ}Oo;f|;z4Ll+_r>@1-xl3| zawq-H%e&ckC+@AhPrP6BKT#_XdT7&;F71j}Joy zkC~6lh7E@6o;W@^IpRNZ{ptLtL(gQ-CY~4mqW;US7Zxvm_|@yz&e53Bp_lTPlfP|z zrTyx_>lv@x#=^!PzR7qqF<$gm`|ZJZ+;<)Cqu&ot2z=0000WV@Og>004R=004l4008;_004mL004C`008P>0026e000+nl3&F} z000OhNkl?W98HS&I&dI$ucghVR2^mNtASFN~V1Q**q&P&ERz$5(M4_My zVriEyZR=212bZ|4Ev;6Ry40F13nB>>D#{=V0W5?FBq2hGW+HRQbcZB&IA`}qFg4^R z(Y`;rrw}&dxtM@69GL7Rhfh)%pgEFBq8Ghs&d+H zjVN+iwEaR*BjuRVXrl%eAP^H;y#B`mzQ6+xrzPQ*DKTVEj3UitA>L*}RRmpqAsRjY z87CUuGd{o2bAMgC4^*)u(G~fMrieqvC{9K+pecf`{?IRby83=MCCO=Bxgd>u(&I>v zwT+rldvB1vUv-dQ+I;u^%8Pdsp}v>uvaB@>=?-T@g!=^%s-UK$uRvABJkT z#b#26@jk8TqNS&w<(Ua#&1|n|nGcnG#5J|lp%Ydc`YTJE#(#BhJw%?aQ zR-!Yk_{+yH@aX$zAf$8Kyou~snt?@AhVlHm!F}(Sv+GoIPjaH;8X-CRZ4=7S%oS=c z_U^MsM&uk?ef5aJC9tWu0c;V(rMURGyoE2CJz=?KRbl5(W^v<;_^5_PcZq~aLWD6O z1hlyO3)AE6H<$iwJ}FMisJkL(>Ui)5XlwN{IVFlY364?M#wROhvobr?+T`vpmXf4l z2Ks}>V}X!y_r8_0ndFKbRZL1KI@ivuD`R*dJB6CMZYtV+V{W;3mP}`Mf+MEQ8~AXD z0ZkDuUr^s@2*LW@l^m$<998I>-H1S zjZ9UDr2vWme182mlcFQZOmMLCvubYIT+HM9s^|+D!-PVH>6fcALZAqN*528>?vbn{idN0xk;T)&q_VNF zf?2O0C%>#^h}g#B2Ji;Rzbk$4-I}W=kTgAx)jQ4%;eOHL;m)mPJoL^<+)W-9ElA_Y zPp@XzvRU+nj3i%3&tcpji|(**I4JA7`{Xw`cA-aRzj;FP@V_Jv?T|O;pBfzFvEA~) zonOk!ar8pBWObn|sBD)~O8L^!I?4K7l2rvV_QfLk*2%^p{M+6=EqQkT7Nye{xMN|O ziyfil)PByuv>ABA?DyT|wYShSkUR4H8jTP^e;g}M` z)7h!KQrtl5^9R{l-pb+nZf3sn9~R}EWJauw+#k;*Z$|~?Z9X(bjHsI&Wg)>~vM6YZ zCE7Y_QDozZ2Aa!Td3Qx70DHgcptr@t@@-}0Y$>JcTs!A3_7XHCuiZKoVyvtvJTt1M zJwnA6p&AMTR57wsPeAAKZRKQKo5Gz_VgM+-FN4?C&1am$OrST&%3H6bJa_(J#(!Fx zLD|uIww-Gqqtt_fE_IJTG$L{R-t*Ae$Gi8;9DHZd6mqkYm>gq8@95>X3$Gx_Y37?W z9-o^`LPk8Rx0a5m+aEFr=!T*YGFlrwfv}|0tzPnXo@4pqbgqgU-UlcGFl#ip{lmuc zmS)gf)6K8B0(HJbs>9a0S!GTL;HawRmv5{TDT>)%3}sy6$`Zx`A08s7-4> ztmK`2Rp2m_lH_1_RR=x&K`w75;%z3(5h|@7KYo4au^p)?C_Ts3O4rRN z!EOTJKy?>LS*?w;Xdl$IdN+Sm)xnZ!u}ENd)kTQ2krr)b`^hG@AFktjLja0G`~*9i z%R*y)Hx=z(671vX3mSY>)q&k%-l+*eE1I%*(}~8MCDURNz`CoGc&^|KwVi$B-f|_& zX2yq&k?1gEHK{c8^wS@vaGmey<>8%QLYt4QIf=}@)ZpZmHq+SZVPb+KPm>ZRxFVlA zaJDVyKus4nUJ=b7emIE~r-h(lkUKYd#3Tc{L3dw>c}d|rrv<4lCPzn7QrAUpb}Dw0 ziY_G^4%ZUtF#iScisX$)P=uhVr|*M_QI^Hkk6!zozw)fj#gv_C<+CTQV_{nKcbfC_ zkI(b!!D>A<(P`HW*{=W?Qj+M3Tv5~Jt6#jO^gA0cX#yftMmceZU~@?$uO6u*F4lgB zVaWa=Etxc=cVe7<-mcTl-kUB}w6S1T6^IyE?PK9@$1jk(tsIxryecw6*&{FS3FSbu z*P5K@n0KJO#kYKnv;6yDQ*i^oD5$_S-uh&eMa$C-8NMx-fRLO`PIS)RTGG^U&6_7U z-r)Yf1NZnt$LhL^u6w(Lwf{axNs~Kl zK|z;9nTJ->7H@!;KCdJ5^ * { + --md-primary-fg-color: #0092d2; + --md-primary-fg-color--light: #0092d2; + --md-primary-fg-color--dark: #0092d2; +} \ No newline at end of file diff --git a/docs/examples/PLACEHOLDER b/docs/examples/PLACEHOLDER deleted file mode 100644 index e69de29..0000000 From c1b7e4e7c45380351b23abfb00daac567cd99324 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:51:34 +0100 Subject: [PATCH 06/13] Migration docs to mkdocs --- docs/api.rst | 12 --- docs/api/build.md | 3 + docs/api/console.md | 3 + docs/api/docs.md | 3 + docs/api/style.md | 3 + docs/api/tests.md | 3 + docs/conf.py | 154 ----------------------------- docs/index.md | 10 ++ docs/index.rst | 31 ------ docs/installation.md | 7 ++ docs/installation.rst | 9 -- docs/license.md | 3 + docs/license.rst | 5 - mkdocs.yml | 139 ++++++++++++++++++++++++++ src/compas_invocations2/console.py | 18 ---- 15 files changed, 174 insertions(+), 229 deletions(-) delete mode 100644 docs/api.rst create mode 100644 docs/api/build.md create mode 100644 docs/api/console.md create mode 100644 docs/api/docs.md create mode 100644 docs/api/style.md create mode 100644 docs/api/tests.md delete mode 100644 docs/conf.py create mode 100644 docs/index.md delete mode 100644 docs/index.rst create mode 100644 docs/installation.md delete mode 100644 docs/installation.rst create mode 100644 docs/license.md delete mode 100644 docs/license.rst create mode 100644 mkdocs.yml diff --git a/docs/api.rst b/docs/api.rst deleted file mode 100644 index 360bea0..0000000 --- a/docs/api.rst +++ /dev/null @@ -1,12 +0,0 @@ -******************************************************************************** -API Reference -******************************************************************************** - -.. toctree:: - :maxdepth: 1 - - api/compas_invocations2.build - api/compas_invocations2.console - api/compas_invocations2.docs - api/compas_invocations2.style - api/compas_invocations2.tests diff --git a/docs/api/build.md b/docs/api/build.md new file mode 100644 index 0000000..9506db0 --- /dev/null +++ b/docs/api/build.md @@ -0,0 +1,3 @@ +# Build Tasks + +::: compas_invocations2.build diff --git a/docs/api/console.md b/docs/api/console.md new file mode 100644 index 0000000..31def5f --- /dev/null +++ b/docs/api/console.md @@ -0,0 +1,3 @@ +# Console Tasks + +::: compas_invocations2.console diff --git a/docs/api/docs.md b/docs/api/docs.md new file mode 100644 index 0000000..7074b0a --- /dev/null +++ b/docs/api/docs.md @@ -0,0 +1,3 @@ +# Documentation Tasks + +::: compas_invocations2.docs diff --git a/docs/api/style.md b/docs/api/style.md new file mode 100644 index 0000000..0ebb07d --- /dev/null +++ b/docs/api/style.md @@ -0,0 +1,3 @@ +# Style Tasks + +::: compas_invocations2.style diff --git a/docs/api/tests.md b/docs/api/tests.md new file mode 100644 index 0000000..7ed4d43 --- /dev/null +++ b/docs/api/tests.md @@ -0,0 +1,3 @@ +# Test Tasks + +::: compas_invocations2.tests diff --git a/docs/conf.py b/docs/conf.py deleted file mode 100644 index ef7168e..0000000 --- a/docs/conf.py +++ /dev/null @@ -1,154 +0,0 @@ -# flake8: noqa -# -*- coding: utf-8 -*- - -from sphinx.writers import html, html5 -import sphinx_compas2_theme - -# -- General configuration ------------------------------------------------ - -project = "COMPAS Invocations 2" -copyright = "COMPAS Association" -package = "compas_invocations2" -organization = "compas-dev" - -master_doc = "index" -source_suffix = {".rst": "restructuredtext", ".md": "markdown"} -templates_path = sphinx_compas2_theme.get_autosummary_templates_path() -exclude_patterns = sphinx_compas2_theme.default_exclude_patterns -add_module_names = True -language = "en" - -latest_version = sphinx_compas2_theme.get_latest_version() - -if latest_version == "Unreleased": - release = "Unreleased" - version = "latest" -else: - release = latest_version - version = ".".join(release.split(".")[0:2]) # type: ignore - -# -- Extension configuration ------------------------------------------------ - -extensions = sphinx_compas2_theme.default_extensions -extensions.remove("sphinx.ext.linkcode") - -# numpydoc options - -numpydoc_show_class_members = False -numpydoc_class_members_toctree = False -numpydoc_attributes_as_param_list = True - -# bibtex options - -# autodoc options - -autodoc_type_aliases = {} - -autodoc_typehints = "description" -autodoc_typehints_format = "short" -autodoc_typehints_description_target = "documented" - -autodoc_mock_imports = sphinx_compas2_theme.default_mock_imports - -autodoc_default_options = { - "undoc-members": True, - "show-inheritance": True, -} - -autodoc_member_order = "groupwise" - -autoclass_content = "class" - -# autosummary options - -autosummary_generate = True -autosummary_mock_imports = sphinx_compas2_theme.default_mock_imports - -# graph options - -# plot options - -# intersphinx options - -intersphinx_mapping = { - "python": ("https://docs.python.org/", None), - "compas": ("https://compas.dev/compas/latest/", None), -} - -# linkcode - -linkcode_resolve = sphinx_compas2_theme.get_linkcode_resolve(organization, package) - -# extlinks - -extlinks = {} - -# from pytorch - -sphinx_compas2_theme.replace(html.HTMLTranslator) -sphinx_compas2_theme.replace(html5.HTML5Translator) - -# -- Options for HTML output ---------------------------------------------- - -html_theme = "sidebaronly" -html_title = project - -favicons = [ - { - "rel": "icon", - "href": "compas.ico", - } -] - -html_theme_options = { - "icon_links": [ - { - "name": "GitHub", - "url": f"https://github.com/{organization}/{package}", - "icon": "fa-brands fa-github", - "type": "fontawesome", - }, - { - "name": "Discourse", - "url": "http://forum.compas-framework.org/", - "icon": "fa-brands fa-discourse", - "type": "fontawesome", - }, - { - "name": "PyPI", - "url": f"https://pypi.org/project/{package}/", - "icon": "fa-brands fa-python", - "type": "fontawesome", - }, - ], - "switcher": { - "json_url": f"https://raw.githubusercontent.com/{organization}/{package}/gh-pages/versions.json", - "version_match": version, - }, - "check_switcher": False, - "logo": { - "image_light": "_static/compas_icon_white.png", - "image_dark": "_static/compas_icon_white.png", - "text": project, - }, - "navigation_depth": 3, -} - - -html_context = { - "github_url": "https://github.com", - "github_user": organization, - "github_repo": package, - "github_version": "main", - "doc_path": "docs", -} - -html_static_path = sphinx_compas2_theme.get_html_static_path() + ["_static"] -html_css_files = [] -html_extra_path = [] -html_last_updated_fmt = "" -html_copy_source = False -html_show_sourcelink = True -html_permalinks = False -html_permalinks_icon = "" -html_compact_lists = True \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..ecf05f1 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,10 @@ +# COMPAS Invocations 2 + +A collection of reusable pyinvoke tasks for COMPAS packages. + +## Features + +- **Project Management**: Tasks for releasing, cleaning, and managing changelogs. +- **Documentation**: Tasks for building Sphinx and MkDocs documentation. +- **Code Style**: Tasks for linting (ruff) and formatting (black/isort). +- **Testing**: Tasks for running pytest and doctests. diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index 27fd830..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -******************************************************************************** -compas_invocations2 -******************************************************************************** - -.. rst-class:: lead - -A collection of reusable pyinvoke tasks - -.. .. figure:: /_images/ - :figclass: figure - :class: figure-img img-fluid - - -Table of Contents -================= - -.. toctree:: - :maxdepth: 3 - :titlesonly: - - Introduction - installation - api - license - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..5a6dcbd --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,7 @@ +# Installation + +Install `compas_invocations2` using `pip` from the Python Package Index. + +```bash +pip install compas_invocations2 +``` diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index b12de57..0000000 --- a/docs/installation.rst +++ /dev/null @@ -1,9 +0,0 @@ -******************************************************************************** -Installation -******************************************************************************** - -Install ``compas_invocations2`` using ``pip`` from the Python Package Index. - -.. code-block:: bash - - pip install compas_invocations2 diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..0e8c6fc --- /dev/null +++ b/docs/license.md @@ -0,0 +1,3 @@ +# License + +--8<-- "LICENSE" diff --git a/docs/license.rst b/docs/license.rst deleted file mode 100644 index e6a80ce..0000000 --- a/docs/license.rst +++ /dev/null @@ -1,5 +0,0 @@ -******************************************************************************** -License -******************************************************************************** - -.. literalinclude:: ../LICENSE diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..95b913c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,139 @@ +site_name: COMPAS Invocations 2 +site_url: https://compas-dev.github.io/compas_invocations2 +repo_url: https://github.com/compas-dev/compas_invocations2 +repo_name: compas-dev/compas_invocations2 +edit_uri: blob/main/docs/ + +copyright: Copyright © 2026, COMPAS Association + +extra: + homepage: https://compas-dev.github.io/compas_invocations2 + version: + provider: mike + +theme: + name: material + palette: + # Palette toggle for light mode + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode + font: + text: Roboto + code: Roboto Mono + logo: _logo/compas_logo_white_transparent.png + favicon: _logo/favicon.ico + features: + - content.code.copy + - content.footnote.tooltips + - navigation.expand + - navigation.footer + - navigation.indexes + - navigation.sections + - navigation.top + - search.highlight + - search.suggest + - toc.follow + +extra_css: + - assets/stylesheets/custom.css + +markdown_extensions: + - abbr + - attr_list + - admonition + - callouts: + strip_period: no + - footnotes + - md_in_html + - pymdownx.blocks.caption + - pymdownx.caret + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.keys + - pymdownx.mark + - pymdownx.tasklist: + custom_checkbox: true + - pymdownx.tilde + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets: + check_paths: true + - toc: + permalink: "¤" + - pymdownx.superfences: + # make exceptions to highlighting of code: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:mermaid2.fence_mermaid_custom + +plugins: + - search + - mermaid2 + - mkdocstrings: + default_handler: python + handlers: + python: + paths: [src] # search packages in the src folder + inventories: + - https://docs.python.org/3/objects.inv + - https://compas.dev/compas/latest/objects.inv + options: + allow_inspection: true + backlinks: tree + docstring_options: + ignore_init_summary: true + trim_doctest_flags: true + docstring_style: numpy + docstring_section_style: list + filters: public + group_by_category: true + heading_level: 2 + inheritance_diagram_direction: TD + inherited_members: false + line_length: 88 + merge_init_into_class: true + modernize_annotations: true + parameter_headings: false + preload_modules: [mkdocstrings, compas] + relative_crossrefs: true + scoped_crossrefs: true + separate_signature: true + show_bases: false + show_category_heading: true + show_docstring_attributes: true + show_docstring_functions: true + show_docstring_modules: false + show_if_no_docstring: false + show_inheritance_diagram: false + show_root_heading: true + show_root_full_path: true + show_signature: true + show_signature_annotations: true + show_signature_type_parameters: true + show_source: false + show_submodules: false + show_symbol_type_heading: true + show_symbol_type_toc: true + signature_crossrefs: true + summary: + modules: false + type_parameter_headings: true + unwrap_annotated: true + diff --git a/src/compas_invocations2/console.py b/src/compas_invocations2/console.py index 63ee96a..d41e88f 100644 --- a/src/compas_invocations2/console.py +++ b/src/compas_invocations2/console.py @@ -1,21 +1,3 @@ -""" -******************************************************************************** -console -******************************************************************************** - -Text console UI helpers and patterns, e.g. ‘Y/n’ prompts and the like. - -.. currentmodule:: compas_invocations2.console - -.. autosummary:: - :toctree: generated/ - :nosignatures: - - confirm - chdir - -""" - import contextlib import os import sys From ac461fcc2c1cb6b83c8350c65e0d9c31e186296a Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:54:54 +0100 Subject: [PATCH 07/13] Delete empty placeholders --- docs/_images/PLACEHOLDER | 1 - docs/_static/PLACEHOLDER | 1 - 2 files changed, 2 deletions(-) delete mode 100644 docs/_images/PLACEHOLDER delete mode 100644 docs/_static/PLACEHOLDER diff --git a/docs/_images/PLACEHOLDER b/docs/_images/PLACEHOLDER deleted file mode 100644 index 48f73eb..0000000 --- a/docs/_images/PLACEHOLDER +++ /dev/null @@ -1 +0,0 @@ -# container for images to be included in the docs diff --git a/docs/_static/PLACEHOLDER b/docs/_static/PLACEHOLDER deleted file mode 100644 index f611256..0000000 --- a/docs/_static/PLACEHOLDER +++ /dev/null @@ -1 +0,0 @@ -# container for static files, e.g. logo, banner images, javascript, stylesheets, ... From f6868a2f362becd980dc5e20146c2fc775ba5d61 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:55:13 +0100 Subject: [PATCH 08/13] lint --- pyproject.toml | 1 - tasks.py | 4 +--- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index a6da079..1dd04ac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -106,7 +106,6 @@ select = ["E", "F", "I"] [tool.ruff.lint.per-file-ignores] "__init__.py" = ["I001"] "tests/*" = ["I001"] -"tasks.py" = ["I001"] [tool.ruff.lint.isort] force-single-line = true diff --git a/tasks.py b/tasks.py index 23cd851..34b1031 100644 --- a/tasks.py +++ b/tasks.py @@ -1,8 +1,6 @@ -from __future__ import print_function - import os -from invoke import Collection +from invoke.collection import Collection from compas_invocations2 import build from compas_invocations2 import docs From ac40ff3bd35d674f83fe5fb6a618c022b8d79a70 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 18:56:56 +0100 Subject: [PATCH 09/13] update github actions --- .github/workflows/build.yml | 11 +++++++++-- .github/workflows/pr-checks.yml | 2 +- pyproject.toml | 1 + 3 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index f841d99..fec8d94 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,11 +13,18 @@ jobs: if: "!contains(github.event.pull_request.labels.*.name, 'docs-only')" runs-on: ${{ matrix.os }} strategy: + fail-fast: false matrix: - os: [ubuntu-latest, macos-latest, windows-latest] - python: ['3.9', '3.10', '3.11'] + os: [ubuntu-latest] + python: ["3.9", "3.12"] + include: + - os: macos-latest + python: "3.12" + - os: windows-latest + python: "3.12" steps: + - uses: actions/checkout@v4 - uses: compas-dev/compas-actions.build@v4 with: python: ${{ matrix.python }} diff --git a/.github/workflows/pr-checks.yml b/.github/workflows/pr-checks.yml index fa70e31..4702d8b 100644 --- a/.github/workflows/pr-checks.yml +++ b/.github/workflows/pr-checks.yml @@ -11,7 +11,7 @@ jobs: name: Check Actions runs-on: ubuntu-latest steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v4 - name: Changelog check uses: Zomzog/changelog-checker@v1.2.0 with: diff --git a/pyproject.toml b/pyproject.toml index 1dd04ac..3322e2d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -26,6 +26,7 @@ classifiers = [ "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", ] [project.urls] From 0d28b6fe2a46c0be93b5d60f62f0deb1204ce92b Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 19:01:53 +0100 Subject: [PATCH 10/13] Update index --- docs/index.md | 2 +- mkdocs.yml | 11 +++++++++++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index ecf05f1..0e163ed 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # COMPAS Invocations 2 -A collection of reusable pyinvoke tasks for COMPAS packages. +A collection of reusable [`pyinvoke`](https://pyinvoke.org/) tasks for COMPAS packages. ## Features diff --git a/mkdocs.yml b/mkdocs.yml index 95b913c..0949943 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -137,3 +137,14 @@ plugins: type_parameter_headings: true unwrap_annotated: true + +nav: + - Home: index.md + - Installation: installation.md + - API Reference: + - Build Tasks: api/build.md + - Console Tasks: api/console.md + - Documentation Tasks: api/docs.md + - Style Tasks: api/style.md + - Test Tasks: api/tests.md + - License: license.md From f6f74f9b1caaf1763a87f44ed259efd29449da0b Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 19:26:07 +0100 Subject: [PATCH 11/13] Test unreleased docs action --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 219f923..7d28036 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,6 +14,7 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: compas-dev/compas-actions.docs@v4 + - uses: compas-dev/compas-actions.docs@mkdocs with: github_token: ${{ secrets.GITHUB_TOKEN }} + generator: mkdocs From 9c2bdf18d86f508427b397c5194d9c75846d4149 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Fri, 13 Mar 2026 19:37:59 +0100 Subject: [PATCH 12/13] instal dev and mkdocs extra dependencies --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7d28036..bb88699 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,3 +18,4 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} generator: mkdocs + extras: dev,mkdocs \ No newline at end of file From 7650103ff2176f6a41047d795cc1b5f636999753 Mon Sep 17 00:00:00 2001 From: Gonzalo Casas Date: Tue, 17 Mar 2026 16:00:41 +0100 Subject: [PATCH 13/13] Bump to released version of compas-actions.docs --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bb88699..e3a9abd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,7 +14,7 @@ jobs: docs: runs-on: ubuntu-latest steps: - - uses: compas-dev/compas-actions.docs@mkdocs + - uses: compas-dev/compas-actions.docs@v5 with: github_token: ${{ secrets.GITHUB_TOKEN }} generator: mkdocs