From 044d7cac8c56723d0d4c985d6177e6f100111515 Mon Sep 17 00:00:00 2001 From: nojaf Date: Wed, 13 Dec 2023 11:23:57 +0100 Subject: [PATCH] chore: Update to fsdocs --- .config/dotnet-tools.json | 4 +- .github/workflows/release.yml | 14 ++++++ Argu.sln | 29 ++++++------ Directory.Build.props | 6 +++ build.fsx | 18 +------- docs/_template.html | 82 ---------------------------------- docs/img/favicon.ico | Bin 0 -> 165662 bytes 7 files changed, 38 insertions(+), 115 deletions(-) delete mode 100644 docs/_template.html create mode 100644 docs/img/favicon.ico diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index ae3d1e32..1674353d 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -20,8 +20,8 @@ "sourcelink" ] }, - "fsharp.formatting.commandtool": { - "version": "7.2.9", + "fsdocs-tool": { + "version": "20.0.0-alpha-016", "commands": [ "fsdocs" ] diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ffc08b44..a732b9ca 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -31,3 +31,17 @@ jobs: env: NUGET_KEY: ${{ secrets.NUGET_KEY }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + # Upload the static files + - name: Upload documentation + uses: actions/upload-pages-artifact@v2 + with: + path: ./output + + # GitHub Actions recommends deploying in a separate job. + DeployDocs: + runs-on: ubuntu-latest + needs: Release + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 diff --git a/Argu.sln b/Argu.sln index 9416f460..15447c27 100644 --- a/Argu.sln +++ b/Argu.sln @@ -2,33 +2,33 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio 15 VisualStudioVersion = 15.0.27428.2002 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu", "src\Argu\Argu.fsproj", "{D3E958F9-5FFF-462E-BDC7-A03272A9F5D9}" +Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu", "src\Argu\Argu.fsproj", "{D3E958F9-5FFF-462E-BDC7-A03272A9F5D9}" EndProject -Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Samples.LS", "samples\Argu.Samples.LS\Argu.Samples.LS.fsproj", "{E0563A30-4451-4DF2-9D21-26C76EB85C22}" +Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Samples.LS", "samples\Argu.Samples.LS\Argu.Samples.LS.fsproj", "{E0563A30-4451-4DF2-9D21-26C76EB85C22}" EndProject -Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Tests", "tests\Argu.Tests\Argu.Tests.fsproj", "{8E234746-5098-4400-98F1-62C77AB91711}" +Project("{6EC3EE1D-3C4E-46DD-8F32-0CC8E7565705}") = "Argu.Tests", "tests\Argu.Tests\Argu.Tests.fsproj", "{8E234746-5098-4400-98F1-62C77AB91711}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{6CAC8891-E2B6-4CC8-AACF-0AAA4F2A49D0}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".config", ".config", "{6CAC8891-E2B6-4CC8-AACF-0AAA4F2A49D0}" ProjectSection(SolutionItems) = preProject .config\dotnet-tools.json = .config\dotnet-tools.json EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{83FE66F8-6E59-4178-8962-11117B51F39C}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{83FE66F8-6E59-4178-8962-11117B51F39C}" ProjectSection(SolutionItems) = preProject .github\ISSUE_TEMPLATE.md = .github\ISSUE_TEMPLATE.md EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{EE42293D-9398-4EF4-B151-9DE992EBB85A}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{EE42293D-9398-4EF4-B151-9DE992EBB85A}" ProjectSection(SolutionItems) = preProject .github\workflows\build.yml = .github\workflows\build.yml EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{306D68AD-1E01-4367-9498-EF4CEDE0AF38}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".paket", ".paket", "{306D68AD-1E01-4367-9498-EF4CEDE0AF38}" ProjectSection(SolutionItems) = preProject .paket\Paket.Restore.targets = .paket\Paket.Restore.targets EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2687163A-E0EA-4EC6-A388-430314AA8C85}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{2687163A-E0EA-4EC6-A388-430314AA8C85}" ProjectSection(SolutionItems) = preProject .dockerignore = .dockerignore .gitignore = .gitignore @@ -50,30 +50,29 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution RELEASE_NOTES.md = RELEASE_NOTES.md EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{C9E28045-41C6-422E-9928-4220EF3FF19B}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{C9E28045-41C6-422E-9928-4220EF3FF19B}" ProjectSection(SolutionItems) = preProject - docs\_template.html = docs\_template.html docs\index.fsx = docs\index.fsx docs\perf.fsx = docs\perf.fsx docs\tutorial.fsx = docs\tutorial.fsx EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{10ED3503-22F2-42EF-8B35-C979A5B700D0}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "img", "img", "{10ED3503-22F2-42EF-8B35-C979A5B700D0}" ProjectSection(SolutionItems) = preProject docs\img\logo.pdn = docs\img\logo.pdn docs\img\logo.png = docs\img\logo.png EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "resource", "resource", "{B1E24C6F-9B2C-4102-B99A-9065B5745E6F}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "resource", "resource", "{B1E24C6F-9B2C-4102-B99A-9065B5745E6F}" ProjectSection(SolutionItems) = preProject resource\logo.png = resource\logo.png EndProjectSection EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{A15390A5-BC39-433F-BA25-8775B4C2E329}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "samples", "samples", "{A15390A5-BC39-433F-BA25-8775B4C2E329}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{93AB3CBB-7714-49DD-9C6F-40E153A66E8F}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{93AB3CBB-7714-49DD-9C6F-40E153A66E8F}" EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{E40F0B06-703E-4541-826F-3B8AED67AF7B}" +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{E40F0B06-703E-4541-826F-3B8AED67AF7B}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/Directory.Build.props b/Directory.Build.props index e9e62fb1..a26a527a 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -21,4 +21,10 @@ + + + + https://github.com/fsprojects/Argu/blob/master/LICENSE.md + https://github.com/fsprojects/Argu/blob/master/RELEASE_NOTES.md + diff --git a/build.fsx b/build.fsx index a03cc1ed..59c3c19e 100644 --- a/build.fsx +++ b/build.fsx @@ -123,21 +123,7 @@ Target.create "NuGet.Push" (fun _ -> Target.create "GenerateDocs" (fun _ -> Shell.cleanDir ".fsdocs" - DotNet.exec id "fsdocs" "build --clean --strict --property Configuration=Release" |> ignore -) - -Target.create "ReleaseDocs" (fun _ -> - let tempDocsDir = "temp/gh-pages" - let outputDocsDir = "output/" - - Directory.ensure outputDocsDir - - Shell.cleanDir tempDocsDir - Git.Repository.cloneSingleBranch "" (gitHome + "/" + gitName + ".git") "gh-pages" tempDocsDir - Shell.copyRecursive outputDocsDir tempDocsDir true |> Trace.tracefn "%A" - Git.Staging.stageAll tempDocsDir - Git.Commit.exec tempDocsDir (sprintf "Update generated documentation for version %s" release.NugetVersion) - Git.Branches.push tempDocsDir + DotNet.exec id "fsdocs" "build --clean --strict --properties Configuration=Release" |> ignore ) // Github Releases @@ -203,7 +189,7 @@ Target.create "Release" ignore ==> "Bundle" "Bundle" - ==> "ReleaseDocs" + ==> "GenerateDocs" ==> "ReleaseGitHub" ==> "NuGet.Push" ==> "Release" diff --git a/docs/_template.html b/docs/_template.html deleted file mode 100644 index 2d5831a5..00000000 --- a/docs/_template.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - {{fsdocs-page-title}} - - - - - - - - - - - - - - - - - - - - - - - - -
-
-

{{fsdocs-collection-name}}

-
-
-
- {{fsdocs-content}} - {{fsdocs-tooltips}} -
- - - - - - - - -
- - - diff --git a/docs/img/favicon.ico b/docs/img/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..3d87bbc0a635f306e4a0ab552f0f84f09935f5c6 GIT binary patch literal 165662 zcmeI5*15~0W0zMeUVYm6e?CPZ~*OMr6h>&o}lZE9+14|AmDt`S0Jd{!;PhtiNVuW&K?q z@~5nWfAaq>PqVUq`E%B_|H)E^`dj{U`N5#zK^ss5)BrU=4NwEr05w1jPy^HeH9!qe z1JnRDKn+j>)BrU=4NwEr05w1jPy^HeH9!qe1JnRDKn+j>)BrU=4NwEr05w1jIIV$+ zOC93ySe@t?tjgG_4$1_KXFGpOs-Dit^ zoKBY*zPt0j&Lh{lMxMRZD{>3>itPN~ z#DkUF;>W)~XZ*4D_JzgB*oC&F?8CI(-D$hi-)HQ6n@Veu=6?NsJLB2Vd?O!3d2#SW zBl%z+lCTC$KD4&H;2uA5lzfnjgt^f968YHOkdI(K z&fMrxbvLk4Ra+qr^|X8T$SL?OfdA^oqJTVve2|Y|J`N4nD9z*+>=RobH^lG%`Rd8z z{q|dnjWg$`tnree!B%s-fan0yRO z`Za^P$GZ=2Jj=)TKR%1f>N3T{$?4-No?{au>hH1xx#WZShou3NkJiJLN+bD2*`8$s z;wsJJfNn)S!MWS?al<{!*IOg^d`i)4$G6`<$u>HF+tvEp zmnyEvFLisiwh8$lA6g4=^JUrzjp#I0*JV@XV%(gsrbPT}@BgY}Z|*-b*Vgre2@>#$N8nhR{Htr>-zxRq=Jvh=`o87&4=lZPmb93 zPIn(Hs<`^9N&~_y_xbbBqi0&k2kRhKIU9_exZ0^SgEaKZ_m2U(Nd+HkZ(fL+dY>pN z%N6st{Q1S^hjr06*llrxH9qZlm#NbeDz0d|GQ(?XJ*a+19}sN9{Db+2&Oe5xnv^!s zAAs_?shf13qb{8z*T6+ya%8m6miL;P_Vdx!*%T07b6dT#K~r}H`C$GLkbm^by&+Kd zD6cGb6(3-8O0GK&K3Y2h)B8lZ)qNksqXPka^dIR_Hqhftn148ze_#)ip;Jxbpd9~N zD%;eHE3yUJ)-fLT$jL^5eI<0-9m+*tU3>olQCU|Y{pKkDXkWsdFRUvb%8&jHVfP=e z7Z{sbQt5woMNPhFI#eM>&$fp2+bQSDfR6(;Y(s(9iY!|hi1rM?1jbbL@;nY*BVYiX|!8OGbK zHPO@GA#!EkKRCj;s)1oSPGr{a@7I0*2pB7)`4~Ai7!V%$aE=G9O}J-o_KK>8A~nu0 zuW+BJIp`C}yKCz!1^&j`+0eQ<)<^rlB)P&qMQUArd7rPUM4(*U&|D)*eTB*|t_@E& zht&DW*)GKso>5quE9x4m)U&JWDg?$+NcC^Jm+JQN>jpEd6>&-ds3s;&j|0h=H#ICgwEfDheAm|yJg17ZGQKQHH( z`b0sAe-D!Ou4eJ!(_6JRKGw&_@$vJf(kt|fwB5`{F5MrH`9qCjptvkg?Zcw|Y4_rl zvle6M@77$wMY|-z1p_EMY=7Abc=pS+r)o?t?m19jB*3EfkGuw&!8nWHbRB<}R~0L* zAx$^yCtDxi2(80p_-N~Fw6r{Wd`R`-ZGYYpZHN57L-(QhKt7?Fz&YL(<3%P<9TVUJ z*Mj*#JaL?xnGT5SiBse1_Z(?I*oA!9&qtLUBMtqXIe$`o{`NjVpIYNzzJCyUjd|oV z-~!*{*!foFx1cy%Y`$L$>G$i8j{<2X_(3{%&M0e@%RPbgUM_fsexB)q8E6sjh%!~I zeC+#~7O%Z|9-t}c@%qiHN{7ktQC?Z3!Z>pDa6tHAu}H=>93MFa{xVhXK%3rV6pN7=78OGJQ8TG8X zwo>I6^ZlUtz9ZcN44L-^pQC@Hvbt23zxG@CSG4@2sNAp7A=!o$T>g6S=uXmn6qIDE zFz$zF!`1ckQ2B?>JMJwn25<##m+symA0hUFDx1#!*b6dt;KL|GWmyY z!(ElOgSO2hQvF=N%gU4c0e;|rT%qBpx%peBid8VV_|Vt zF+)Dchpx|ta?wVLHdN?7nznKM(dzx58uf|EE1l}R`*250e&HYWmjXGaaOO^*%7aSE z^JDgV?fOOaJoF19F6{%+`#;Pwk9i(T{bOQkbVvEe3`5sHQ06p$$N7oram8Px`bRwF ztHu_8Uubau$H?fQYQHKh+plcG_A7hauSQO{D9xRe-!m3IR2@LJB~D!GP~W4lEL%Y1 zXakPs|M}}DvL9@(K))Z_zuNi^sAtd0zPf0BHCyOM(|s_p^bbO-tItCnn8JXvy z9&n(xY=^dW|6o~Vp^VqN9oKa@CBA$WMpsX3z&+bvw`9NHK3n-<|6qF7PedIXuJIAIf*ZLC`F+SPpEo~qh% z%OBeKmLK1>?r&_ZRSbYL^r1hK<-bQy9|-u@;oFseVB8h@KZcI>ThGV)_78G=iPnQt zt|})<-9q~)KZQ!mU%Xyb^?0x_KGSY#bmmUK#TV)pq5Pu!U)$i%D^RC4GR)mezC@1*~Nz*pNKTZd{;d_QLo#~@|C^iD`*vEok2Oi3VpC(1Y_!^ z&rXVY*@t%e+)4E}(tYSNxc?je(HDX|1=rDjJ34+uT)%NujU^f!?zP64fDO#qF!?}V zJiaab7L??OL%nU{{KaYYY?S4YX5$);@tL*&zZjQ-G!^xyaO2xw%Jw$&f9Uia8ZJLj ztn`cex~VmNzVi6KSdw*$wT%~&*%zX#x7FeR@2B~|{TP4M-T&Y5SFN25>iWjJ*D4I; zCpuj1B5WL?%5EP%ZK`XyZZfaeE(snh(9m3~Y{2pD_H$wC6z9knYMP5JJ!)Non`*g6 z2Ko|%{pi1;bBs+y--h<5-BLLwrAOAOXTpqc1fLiei8f>HN4t5l9ADp2X4N_L^Wfr{ zdfWxZLTUYZ(S5LTN5vKMq0IQ{`B50h0GlxXaGn$B4t*QQE6^8*GL)&yXy@Q)@I-_1 zk2*%Q`_1d94}ldt8~Fv^#k?MTUgFD9y1BV@JwP|6hP-f&yhf)5=2!sz8^)KyHsr&3 zK7uvq=D+p&3Gp5_B{u27By52*Kmd6e_;w;r2FKFCHes~tc4KrqJ^8uCJ35h@PI zGtf>49&Rnot9a`5eRSUk`5+&`d|*zAE@Plh972%amP3v zZ5NiW$cWYgT-0wgANQ7*Jj(}oK-(_j+R#+1`a5e5`sat$wfe_H!ye>=e3*RT9PMM! z4b~0uLS7Lr4s-KYR6Nn&gE=OJCH{E#Pt-I2kU9v~1^@Qj1nphm1M3T-k3XEgGW~b- zhoGMnan*SV+QIc$2IztL2RR8&7trU3HXOx>bWvaR>H!`QPko?o$g~IfARne4^f~J3 z!Fwxd4SChYTuO7i4QxR^$cJVk*j0Uta_r-AIkwo#2gW&IZn9njz_bJTARne4cpj(+ z@)2kc>Vx($H9$V72U8C`57Yzs2($VbR&+JpL_JxmR_jgL2* zul(yU%Q@7TN1f<_HFnVV(_yTiX~vu9ylF>_Xri>)`nFZ!!@{176|-Z0P+lz=ob9 z87cm}Mm{2Gz$<**f4HR9>p-~*>k^O+>OPY0W4-1DKCaCA*ZBt<*vkz2)5IEo-baoi zX&{sNz?>GWE2ZkTA8s{|X^dr9x_5>LE&FFA=t1DVDL)-2cUx0ugju3Z~Te0dMKh(`mN!pHYNJ_+nu zhWh#IFT_= zcKXrd6Fa+G#Nh$|yJ0^j?2#90{(Pjk@fx*nhX#Cg1^%*2TfM*-ChQ%buH)RyDfKSM zGjQYTvCM)Agn_mcs; zHE?>NTeS4})H-=O?M|m#)ld|2k0ZO|&G5()H9!qe1JnRDKn+j>)BrU=4NwEr05w1j zPy^HeH9!qe1JnRDKn+j>)BrU=4NwEr05#xk4P03s5)WQow#MgNe>5&0uFYD1^ZR@I z`}6yT|Gr@3+1n-YR36$+;N#mL+v3ssb?Y~Mjc#~b(l*|*jb>xx<7!Agz=+8WzrVM> zKfh=A?`g6Ti4QUo-iFkdH*FKlMl?Rih&OdWzIT4tP;A7)2N-#|bzjy;j<8O`H7`7= zfpBcZ$_E&E{eGE@kPpxC5s8g>_#h)Y^JJD>SE6*oc=8&B)c|Vb7%_)Ou!XJ>KsZ z3mb{>0Y)~qp9(UvyYv*V{@i?jtZXF82N@w7Zq|RKcZ-LOWcVN>WF(Rf-FPitHj?E7 zjJ*5wLd>p=vOdDLEmvzG5jO1L1B`5ac}+&hhimyrlnuN1AR{bmxv@NjcS?p0JNeLz zU<|NZZN>N6T^uLNhTVLCk&oXt#Qft4GQ#p!S~Xw?8&2>+Ms`;k?Z!OWE;gLvgN%@o zba7)R8&2{8Mz+7b6}O(AN^3rwuJ6R>raq0Zn+>P=03)Bjzat~8i#VP}I>CnGV`I^J z_qmm0YW_KNZRbHoQlFOYru@q(HeSDfDCQoGS$x2zSii(hHgs5EWa-)IfM@NdZ^*bh zlSZVH4gC$BV&uz@5902N3uJ`lEn75@4mQY$GwGbRD_wi+n@%?LH)K9y&$ra}q-&2o z-N1(amQFIV{Q8wSGE^NrKN#+~QqW6~!X zp>~tecCvoc!N!v}3vsO@>Lepv^OyXEV<=s01oxkZdq4AcCmG?IzhuPJ8qU+nMk0LR zoyiDw9IRs}{!TX=iSj{4$cGa=m|?nsjb!+6nh~z~yL%aQ3meJu;WQ&$^LO_#;wCoi z;De0pJ`J1YAUn_9#)e&dq=FHyXXOF(;e9&bKA5#iRhU6FGr5`9)G#sscz+;n8k2h1PY`utLk&*$E{$!a#0{uiE1 ziuDhV64q=utz$fTsCZxv60AiM&R?Y8o#q2;@nTJ0y^e{UF4ud=-25q17;%yhvXQy^ z4V4bt{aYq5;uIfbgKWgYliL|_f)6Lzz&dk_Pr1%qEZWPId)&;3-F!IB2G_gxX1?TB zM(pH+Yl2VI&zo$OhSPl1(=-k|-ZevVpOO*sI4$+cWIUU_0H6B*KT&Y|O5Vk`3+=Vrd|q zjKs?a*~pA^*K7G>x)_Ov4=35!{PbKf-ynODxK0NnkJsm|d@RztImrgsULY5dv}ayR zH6xhIWj;UDIoY6oL+K)2zonXyNbw{aWFwM3(sj)Zj5x^#)((v&?@E{b`CRv>3+ZIU zX*M_~*8Td+gft=@jF1g#Hxt;<@0dzPoMeN07LYrwX}evg7{S^n`dzO*9C2(dg?Rc| z^!v~yPw{BL2}VraV*MaH*B8-Yna_wPzPy)w#H#_j88Nl%1RrMj@y3<+laE9+U?(G{ ze(mOCWo^zXyCo7&`XL{QYQQc=oZ<3B+3Wa;F^Zy!wLPSBFtDBNrVrwK`v6EVW*!F3nTIJ z!L@M7hSR!DW%$t;iH8rcf${IDe1ATRJUXp`NQ}hF2ic%boz`hO!w<(uEPRj+vXM^h zrs~ULQ*TN+msnVw#o)gSSBtF0f*EA#_ZqRKi-@#-g93NzZT%=NyZhMwyBorT9 z3zuxTO|R*AA271IanowA#r#38g-bTlp+&bo6Kj^}ce}bgEO6+*>5>&{fEu6%r~zt# z8lVQK0cwC6pa!S`YJeJ`2B-mQfEu6%r~zt#8lVQK0cwC6pa!UcNE*oEf3yHCKnu_U kv;ZwY3(x|z04+cZ&;qmoEkFy<0<-`vKnu_U8EJw42O$#x!T