From 624569991332f0a27b1fe3e2147233a86a246b03 Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Tue, 30 Apr 2024 16:54:30 +0100 Subject: [PATCH 1/8] Doxygen CI --- .github/workflows/Doxygen.yml | 39 +++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/Doxygen.yml diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml new file mode 100644 index 00000000..0afe6d33 --- /dev/null +++ b/.github/workflows/Doxygen.yml @@ -0,0 +1,39 @@ +# This is a basic workflow to help you get started with Actions + +name: Doxygen + +# Controls when the workflow will run +on: + # Triggers the workflow on push or pull request events but only for the develop branch + push: + branches: [ develop ] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "Doxygen" + + Doxygen: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + # Runs a single command using the runners shell + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@1.9.8 + with: + doxyfile-path: 'doc/Doxyfile' + working-directory: ./Doc + + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./Doc/html + From 22813dfb7d102da5ae1da242a1c98ab341b6cd2f Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Tue, 30 Apr 2024 16:56:15 +0100 Subject: [PATCH 2/8] Fix tab --- .github/workflows/Doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml index 0afe6d33..730083b3 100644 --- a/.github/workflows/Doxygen.yml +++ b/.github/workflows/Doxygen.yml @@ -29,7 +29,7 @@ jobs: uses: mattnotmitt/doxygen-action@1.9.8 with: doxyfile-path: 'doc/Doxyfile' - working-directory: ./Doc + working-directory: ./Doc - name: Deploy uses: peaceiris/actions-gh-pages@v3 From 986a7e7f18d48ae8c07bf89ab9733898d45b9b7d Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Tue, 30 Apr 2024 16:57:24 +0100 Subject: [PATCH 3/8] Try to auto build the test branch --- .github/workflows/Doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml index 730083b3..b17908b4 100644 --- a/.github/workflows/Doxygen.yml +++ b/.github/workflows/Doxygen.yml @@ -6,7 +6,7 @@ name: Doxygen on: # Triggers the workflow on push or pull request events but only for the develop branch push: - branches: [ develop ] + branches: [ develop, feature_doxygen_ci ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: From 395421de16516cba3a9ce1b36acaec9005781a30 Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Tue, 30 Apr 2024 16:59:53 +0100 Subject: [PATCH 4/8] Update action version - don't use deprecated version of node --- .github/workflows/Doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml index b17908b4..0491e38f 100644 --- a/.github/workflows/Doxygen.yml +++ b/.github/workflows/Doxygen.yml @@ -22,7 +22,7 @@ jobs: # Steps represent a sequence of tasks that will be executed as part of the job steps: # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 # Runs a single command using the runners shell - name: Doxygen Action From 154d26445204cd8f3264aefbe6df5cf2866a2727 Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Tue, 30 Apr 2024 17:00:03 +0100 Subject: [PATCH 5/8] Fix path --- .github/workflows/Doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml index 0491e38f..bd3eccea 100644 --- a/.github/workflows/Doxygen.yml +++ b/.github/workflows/Doxygen.yml @@ -28,7 +28,7 @@ jobs: - name: Doxygen Action uses: mattnotmitt/doxygen-action@1.9.8 with: - doxyfile-path: 'doc/Doxyfile' + doxyfile-path: './Doxyfile' working-directory: ./Doc - name: Deploy From 446550eb134800c31ad4500389b49a4f605770a3 Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Thu, 20 Jun 2024 11:51:19 +0100 Subject: [PATCH 6/8] Make the header logo a reasonable size --- Doc/Doxyfile | 2 +- Doc/mach3logo_small.png | Bin 0 -> 9469 bytes 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 Doc/mach3logo_small.png diff --git a/Doc/Doxyfile b/Doc/Doxyfile index 393033cc..60751608 100644 --- a/Doc/Doxyfile +++ b/Doc/Doxyfile @@ -51,7 +51,7 @@ PROJECT_BRIEF = "Reference Guide" # and the maximum width should not exceed 200 pixels. Doxygen will copy the logo # to the output directory. -PROJECT_LOGO = "../Doc/mach3logo.png" +PROJECT_LOGO = "../Doc/mach3logo_small.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is diff --git a/Doc/mach3logo_small.png b/Doc/mach3logo_small.png new file mode 100644 index 0000000000000000000000000000000000000000..99676f76057da14049edce10780aa7260a740fd7 GIT binary patch literal 9469 zcmXw6`-A|;tsyzNP%4Z-D2wzd*ohERr0{lU+F@gWYriRua5Q?h3jEuUy zr6mZ&mSAaSrl|;K>o+$yGwUDWc>T=9L-X_JFPdfn{hb7%t#}rA&msqUFk(?qB&1&9 z@ld|-Mf7%J7jPqkheck!tyio!>72DFKADcLdY8#FT?nfDI<;X%|A_TjD+xDB>E+9p zT7iz+XNjmp2(*5(*Qg@T`g71MN@V7!qz;*}@3Hk&6yo{f{m}Y#6-E`%Gk)Em_0K3m zh}GmRWR5UUV5!3!!CAkR!a$a&m9Nmge$)LLXt(~Zf;(4wAuvVHDE;q@V?Lg_zfZsqEHrJ_A2U2gD%(i(xdkN|9$xSg9v-VZ z88g|d;IOoywAY+5LF^_$LH)ffeTsC|Naa*+D| z^EBT$&LRg63TRKbD^o2gT*HJSK1Xm1TNCt4r2%#Nn|o#ld5Dagwbi_k>y6RgD9eR# z*Bh&Zx2Q~tWIQM)Wtd2nkvlV8nqrRpROxz88jrg9lyg;n52BwGI|O9X3v zeV0Hl{hawZ4(#_%`uspm38KXH@1$Qaw>M8GF@4kfKqD+aJ*~I9S$9v@zWYxr*FUSl zNZz&G<3m^lGkA#o%p-3(I+?k%b+!DaV_13LziRDC?p}1<9~0q}2ThSJH|gWY11THJ zI|YcpN!=Ka|<)nEhzs%Hsj{%)im${x}Pp<=4$j6nt z^PudO2O_EM57tVCIA!U05Nu}XzsTzm&I%2%-d`$xr+GgVl|<{_9M7!o+(*26$Jp&z zlb-!+*BicEX$9hzVvV`EZ&}KJ!?>l&r*|Hb4X>9s|Ki#~ut^cwzxW6@ko!9edjC)r z6Czc=XsNPzt*<^vj6FpM46Htk9-l1)JgEIVa0?~+LU390vqiB||L%$KXXEhf^2mt{ z;RGA$o`hJ;H@4xn6B?NRBN83+?o(gE(%s!^e6u)V;OvowRds5);O=#6g;D9*PK+>_ zo?w7E?e`_MaiZV^*4*C|(VIudGPC$rveGHmR?uSPZ=8+$>&^YB<7F4SRko@u1f)_O zg8gf0gI(rP{D;#kio>HW8?C2RRFx0)Y$@!dN-rE@FpnC7)^YN3M7rzeWx+!Q^O9eX zhlSv!wEXI9tDB40S^pZofOnBkP)sRSDE$Hr)_&O2yA150I-t7T!J-4H~+XBTBeHZhkA-t$$^~%k(gq+u{oabA7(ExYr&R{ zi`X}g38tNEp$a_KT`M73RG@ z98D+w=C>UXkxX0GOxx z=qU~(y_LCc?-CD68Qp@KtXf%E5moht5utYT*zp@~J(Jx@nb9{`w1Rz#iA+GD74nWB zvC62lOA8!}R?)Fg@6rE)WM+%#!eq&s&Y|hRG`g%V`x(!zQWX{;V!u=1iOb zYg-GhTxuOTks{3RT#TIOQ6?^>;aW{&(qr3z3keAcN14AI=B#+LwA#I2h^0=7VLaO` zfcQLV&Psey*U~(4upO_J?7v%0vZgYz*HEk3M?`N-P$6;A@sz+LXb>1=^*=&u-YhvWJGybb8ccph^(l zTBIx0%kivjE)1jgxP)apqCiueg=xgjC;D#6$^E4e6`L-?%>s3u$4_;udGijZXK^c5 z->Whweo0s)(ARsDKvU8v>Esf>wYjZkn9AvpvUq6qa4${DMcm=sh>%BLCY=T{)H8PZHmb`L7NH0Qf(YU<{sOg_SO07n zn7ZM?EzeYdR5vvY9P|oIYHfNhsV44&^8<4o+D3;To^_l}F$qz-1M^tVqcaxtJUe_1 z8|K__5qU}XcNI-R5D!>(>(xE_UxCMHA?~x&TG&CWy9`MjW{sslm@FFS)nBB`+{*z+ zbEwv?adDWl^6cQ2V=r8~M*Ejd9Yg5aT##a~Jf`R6QfBMT0tT&^KXy0&1U?!A`l{#Y z+ZIc6_Gyu3--IdE6u3ZNzZ7>l)nceSZlpET(Xm9~o4e;l(57Pv-xoqcGbjrdt9%pO zGS=*uJU=N&D#039QRw{APTJ~yP}@J3`fX>b3N{OL~Un z^@9oF$K^bO^89{Yf`}N+qQQ$PA&IJp^spDG65Lf;J|sZqSls^o6Ra(3?%&EZ5}_uiFU?^(WV$m0se?w@ z>9$M>T|D?XK0Afzz9!%y3wU*0eml%!oruosg5S^h&4Y;`urG^eHkL94UniH_Rgh&4 z@B=dia;ijCrbTnt;l?xRj#TCLn;;Nc{L>oYzco{|QAG1xEx18bQ~~wQr^U{WlDukV zV;Wa4J>7JDIMSYdno>Y#`_CoRhFo`UNwqFVVdJvtX1xfx*MfoyC`n{E>i04wnaQ~U zvblk+{ufI62--;pB>0EpI1TRkSit>klSE^GDHGQCPqI_H&)fCrti{)sjipA-Z`JB& z=+j4e=Vp8UotooKTKRegdh#nXCjTlf)Bb?pVzEvb3_Z{3n*0d{;^S$=MW7nXi)b1= zk>dUp7`Gl|LM=e`{zInk?l#@g+h3P*B!NLWT%@waK<1&r)nZEl605R+sTETKBN+~( zBC2f4YrPM1AK7PZcCYU$B>$NPbYITPHfT}&`)8Z8a~31KlcF0b8yt!%!K|nb*4v8> zQ#{&wxu<3CP|;R@-v&E~VL5WAn&iJOLylQoqh}P?D=>R_uFWx2j)2EksaVMfT=o~h zQQ-5!q1l0*=&u}am4~{HT+E zyHqeEtHUKaZ!FqA16&Dn@v+Abtkh3yfSENu21|Y5e;dlordO^UL-_pU{=cm6?-ldT zAp$row2jd=jWoQTrFfCp@-e$2!@lVW(JadaGMY^o%qkmrDaB}@mD!5NYY`^GkH zi2b*9u2@OTpG|e#vP8FP6E_rE-ZbBo&{un=?cj!Y%%&0%LhMc}y4LLi3fjeUyw&HSq{78%169>6(3$H{7YU8hS~uyv41g55r53dSlTWrKv(=eDa`X6|caHxxDgm9$!aq;Yb>D`}^> zFq!0d^fWRfqkc`N1~%OcN77%soZ*|aM(!9W*q!D{`_Dw2g%6vu2@2NfFXhm5G)`Kw znKeayx2aZNWpXDDY!9Te8@0V1>-kVepJ(7igo`EYb!C}lXrEZc|6HG~)~sN0X#W(% z&^Y*@TRMq{7R5+%;+=NrHc9@;+?=7BNJ?mLH+3`zP~+MJg^Af0))tvei)MDmeUURB)to!<-b#c;&Aj~wtBDCU=^G^>Z zo%l?5*e$p&^A$4+ZY1xA{bw1@HR+sdZe?QkouGh!3+yo|C}bDm#t(N%mct_>H9y;B z8Jk09k9ICjnG~X86of*V2i_sPOJ~c5N4Q;FVL?i5()GIXv-q?^ei@5UX|2fw<{*0m zWw;N~JQ6(W=yJDZzZA_$~G`D<^BiTON6{CJF9Y3T<`TE@$s9p{?% zh<|*dZE(WsIj=aB?mL-Ml**n3|a;fq`9SiGT&A9 zDpTrey6Fb~RS&e4xK;dzqzj02=8=LTK^&2)CiUgKBL=aW%~6Zn7S@)Tl6QYn)tM<6 z^789T-%{dTxh-pSDi3Xhafp(ZaXO3$K;Zun?OL+L%XXL0U=u>@xq%lz^?Tj&$|x_-qi4q@(AX`E!VL!C!rJ&`_H8U&JHt+dVl40D6# zF#)EpP>T;FV#C>l7m*#;VPj{DPg~bF4<(W#=}Gd{^IttKjcS?SEZee5#g-IrhKjlW zSZ?~>2)~MnBR=sF21>>fjTo2>wft7(ILkFIT-7I|5NC+|6ri|Y)#Jj133Ze3fHfHV1@vhox|Jgx7uY+!h z$$%#NPU+*Ep%3o0Q9ic8^Hk$`!@QZ98b^PNb^46r2@+h(=9ZfkqnK@7Iy%2QD6P+l zP{Q)_aZ$R1^Oo0oKoRp}y?Wp<-v*lPuR@##vF`hP@-WRP*^~pp4l+&_<|j2{`}=oG zchbVWE)@3g(yqmvHq0{t5<~sN z!A0DmZBs{TPCE)0c$Q83El|#}S!^bg=k8{%K742`Yrl2@gAY{&O?|IO`lGrkkf{_% z7fS=DlE_6-mR!%B=!X@_$3C(9=73Je!MtgKar`80m*|*xQFVk_n2LV3O2zsgHGT*{ z_2-+=RF{AD>+w6_$Gj66YQ7a)?WpM%)ynON08 zgnE#nTFa=BDg(B4Q>rK9LJXFgi|(2{asf@*=7D%`QBRl2TS3m~3P@&-U7)+Tn#r}+ zkNS9YenXZIqHhTZ@6ssud!#n5bki*=My8X+^is}!j|~#7@`J3Q=t}|;0q&pM8>6Ld z2N^&*DbDlO%nU>uM?^HhgyxZ!qN{7C`x2GL&7T?OKYizgMYMQi+e3wp*ts&%5RB`1 zN`aZaMY1hZa(uxTp;`U-rwmrRxx3$JXgC@*WVPge0u*NZv>|txm!| zGS;&3^@Xg_cf_G~zP631p>%`K_YWeq%-BsIf1{16O0-V?jn#jH7b561`i6Hrf++a% zU1E-YXq6xG9_THJFMI~blz{#X7>ZB}?4;|x)3`%DHm0wYD~1@1yi}RiSddMp%!j69 z#$o*uK6fgowa8?-kw8>zK0eNm2f&eM@gwA~bv^*O+1ZqkwlT@OFtQtF3I84ksTp3- zO)Nb%&oGDv+Hh4GaRrvl&AnfK)GLy5olh`}Z2%2HQ0Ur>-~8<_+L5i zP%-+upT4Y2vqBJvB-49hcSLprEbsd2B}^4wqTur6V`1^{K#E| zNXl?_!YxGRzV~x@@Xy6NT4({=poz6(BR<~byM$L(&|ZF(na0Ga1C=aQER)9Q#rGe8 zhJonR4jcWy+Y0y0T~pr}D%bZO7e+%!LwHZu+!P|!?s4j53O~f9NQuStn|5Vwd-87{ zWoiN{0z~$tJVE@@0P%@ev-1(zs@E+w(3pNSW(A-El+04*af%AxC5$-P0hlgPG&(?` zk{$4I$KA34wgk|r`UQo=PV+`fa}6i>1;wK{4R6cDc=fzCrgzIYe)h-~K?F-5k4jQW zu26Tcd&WxTOGqcsgM1n1noU=>yR*lHkY#!`4qXRyS zSN!ehzZ&zDnFi0zGqyN7v5r`d z?S{$dkSY%qRB^}^=D$HSMVY5ji}U<)62E>8w8uDizS>B9RaG^OazS9j!uuF~y8k$| z{j%X5S^7h1t471HcD_Pl)=ExQ#Kw!oDz~Z^{(6WQ$mSZA+P8npcfGcPEWZ$3B@Awj z^Tz;EC0D2jCf=IOd3>2Mvr&($H$XmgBgR#BiAfMaGs&+(8s^FTj(N*gJb{t)q%M2( z(ED5LYv_%i0Obf7S4l|V?Br{_OObGM7tg1c@&u~9jZM8v8Y+0^+x?QhxWpOf;$mh%LeL7Ka&|i&~gRar}6*D>;)ocO}j#wJg)nfQkB|kc}7CnDovi z;<(K{$dmtfAt5yrB@S;#tEvasw+g<}cA6szBjXVnAKEy;{12K*Tt~9*N67)(67gUY zsxPFV^?E0{;$$6Ws%D8F4Ja37sm?ivn<~rbW`7|T-311TjtB~gvX_aYf zloZj44-jDhOfV~2IDU_C9*-MC?hK9yTS0e*Pwlm3i)ZZ4BAzxmwxX>^sU?ROb_ALs zkpN(#74pZHP0`T7sOpn-VU-V1d&s$ZB%yFGH}0MDq8PHHKYa7UhPcofWBpM2b1dsY zi*$`<5eMZCKqvvKs9CA~1}}+~PNb*j1D{d5S7!1hXDr={8b9^M-7q6sn=!!rfI|Y5 zkU+{1CF_ONB`6%lb9{v^E2y*SeMUz^IO-M^Ho*}$ORNEra)krqQb4mo)6Me!y08NH*S53aauc@vLDl5wp5(}H%EUrKT z_JoHm`XcoblC4xZc2b^j13sq+u-~Hx9o@zTVIK=h z`^F9LC9a>k(UyjHnaMHeS|m*9j}pE)qh4+=A|Zl;y=pPZw{o}RqLK&Es?>yc<`S&T7WYh}1D09iypX>g9RUKr zs;_5GT{1Bq@Fup`+BKqzcpsT8No~g_6e`}FTsT>thbiRxZ7R-ZLl{?3+IvG@t=EARjUnm8WGdZnXAdo{iqD8Lk8p5z8UM zW|1r#uB!|^H}+Rr(j;YsP(L5cSD{k-Pk1(dxaM)K_yJno+sB$ddzI^P7V{y$c(HBI2;pjSHW0GB+2R=YFx)v9NiT*xKs zR)ltw{{l0cnLSi?pXYSwdvVu+quHrL% zZT0{z+YNY_`4dw@0o!DCxEw%@=W8O^adGn6;7FjzMLv2RJ{Ktu5z3Bj<2x|iT~XkX z650yTTdZzv2qWU*o%853Xf%1qZ7O)wevtXfr+7st^5vi%nak4b<92uD|{y zQ(mD}IwSN(JPfRuO*r_6LRWxT=*S)3ou>{aIq_Wh2uZhtrpuvBAX@(}2tNN0Eeb5hO&{R4r?TVOE-rJsKm+r@{#D z%K;i0XFvDn(3H=iB7LGdxATqv@`G%&bb! Date: Thu, 20 Jun 2024 11:57:11 +0100 Subject: [PATCH 7/8] Add doxygen badge --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b2f6e568..ed88e853 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,10 @@ The framework has also evolved to allow non MCMC modules to interrogate the like [![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://github.com/mach3-software/MaCh3/blob/develop/LICENSE.txt) -[![Relase - v1.0.0](https://img.shields.io/badge/Relase-v1.0.0-2ea44f)](https://github.com/mach3-software/MaCh3/releases) +[![Release - v1.0.0](https://img.shields.io/badge/Release-v1.0.0-2ea44f)](https://github.com/mach3-software/MaCh3/releases) [![Code - Documented](https://img.shields.io/badge/Code-Documented-2ea44f)](https://github.com/mach3-software/MaCh3/wiki) +[![Code - Doxygen](https://img.shields.io/badge/Code-Doxygen-2ea44f)](https://mach3-software.github.io/MaCh3/index.html) + ## Famous Plots TODO this should be expanded From d0a90e1f2f95e36686a62fb45a19c89e20f19a8e Mon Sep 17 00:00:00 2001 From: Tom Dealtry Date: Thu, 20 Jun 2024 12:05:14 +0100 Subject: [PATCH 8/8] Remove test branch from the list of branches the CI automatically runs on --- .github/workflows/Doxygen.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/Doxygen.yml b/.github/workflows/Doxygen.yml index bd3eccea..9e8cfaec 100644 --- a/.github/workflows/Doxygen.yml +++ b/.github/workflows/Doxygen.yml @@ -6,7 +6,7 @@ name: Doxygen on: # Triggers the workflow on push or pull request events but only for the develop branch push: - branches: [ develop, feature_doxygen_ci ] + branches: [ develop ] # Allows you to run this workflow manually from the Actions tab workflow_dispatch: