From e833ba1701abb45d50826a9a205e7032a73b653d Mon Sep 17 00:00:00 2001 From: Jay Sridharan Date: Mon, 26 Sep 2022 08:15:30 -0700 Subject: [PATCH] Add docs generation workflow (#45) * Add docs generation workflow * remove extraneous backslash --- .github/workflows/docs.yaml | 37 ++++++++++++++++++++++++++++++++++++ .gitmodules | 3 +++ doxyfile_options | 19 +++++++++++++++--- tools/doxygen-awesome-css | 1 + tools/mbed-ce_55x55.png | Bin 0 -> 2728 bytes 5 files changed, 57 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/docs.yaml create mode 100644 .gitmodules create mode 160000 tools/doxygen-awesome-css create mode 100644 tools/mbed-ce_55x55.png diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 00000000000..5563bfaf466 --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,37 @@ +name: Documentation + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch +on: + push: + branches: [ master ] + +jobs: + build-documentation: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + with: + submodules: recursive + + - name: Create BUILD folder + run: | + mkdir -p ${{ github.workspace }}/BUILD + + # Build the HTML documentation + - name: Doxygen Action + uses: mattnotmitt/doxygen-action@v1.1.0 + with: + doxyfile-path: ./doxyfile_options + + # Deploy the HTML documentation to GitHub Pages + - name: GH Pages Deployment + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./BUILD/html/ + enable_jekyll: false + allow_empty_commit: false + force_orphan: true + publish_branch: docs-master \ No newline at end of file diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000000..dbfd2ee97aa --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "doxygen-awesome-css"] + path = tools/doxygen-awesome-css + url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/doxyfile_options b/doxyfile_options index a4475a2857b..05834bb0c4d 100644 --- a/doxyfile_options +++ b/doxyfile_options @@ -51,7 +51,7 @@ PROJECT_BRIEF = # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = tools/mbed-ce_55x55.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 @@ -142,6 +142,17 @@ INLINE_INHERITED_MEMB = YES FULL_PATH_NAMES = NO +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the FULL_SIDEBAR +# option determines if the side bar is limited to only the treeview area (value NO) or +# if it should extend to the full height of the window (value YES). Setting this to YES +# gives a layout similar to https://docs.readthedocs.io with more room for contents, but +# less room for the project logo, title, and description. +# If either GENERATE_TREEVIEW or DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. @@ -1162,7 +1173,8 @@ HTML_STYLESHEET = # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = tools/doxygen-awesome-css/doxygen-awesome.css \ + tools/doxygen-awesome-css/doxygen-awesome-sidebar-only.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -1448,7 +1460,7 @@ DISABLE_INDEX = NO # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. @@ -2101,6 +2113,7 @@ PREDEFINED = DOXYGEN_ONLY \ DEVICE_QSPI \ DEVICE_STORAGE \ DEVICE_WATCHDOG \ + DEVICE_LOCALFILESYSTEM \ "TFM_LVL=1" \ "MBED_DEPRECATED_SINCE(d, m)=" \ "MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=" \ diff --git a/tools/doxygen-awesome-css b/tools/doxygen-awesome-css new file mode 160000 index 00000000000..a3c119b4797 --- /dev/null +++ b/tools/doxygen-awesome-css @@ -0,0 +1 @@ +Subproject commit a3c119b4797be2039761ec1fa0731f038e3026f6 diff --git a/tools/mbed-ce_55x55.png b/tools/mbed-ce_55x55.png new file mode 100644 index 0000000000000000000000000000000000000000..6232ad4653ffa2b95f7c39429197229573a1b07c GIT binary patch literal 2728 zcmZ`*c{~#i8{hAj97z#!bdEW~Sd(LmikTy^ct6kQdA^_L`+UEj=bz_~hjQK0MC6d{Apig%VrFV|V;^6_C;K!Jo7yb$iT*DeCcz{{X%S*z)Ih(O-0}vkl|f}>rYCri6Q%4Z=yjb$gQrW z#rN!t{e3SY{L0e6AP3yAWdWYQdnf~Pa~Huww59vvUo$1I-7zxd@MT*d&i@tH4|&)2 zaOl1}DF0g&YLE1NtTBT4U{ovCvTUbueR+I`r`xyvvmk`_6?@1!mm@(Bjx>sBDem4u zdVw{sW;yFHWQZ7IP)ta)2*O#rvU4v0J#6K-yIQ62-99Ufg9Q?&%EWtn;s*@bCesJ> z8>3*)(2V8rXy8Qba^mka>@V1>rIlFC@Vh$O`|I3Pziv z{8+yewQ?-+rT~y93`cy&iF%;s6Ck{$UJW1oX9&8 zh+iap_9r z%)@c)NH`YV-Npj*8C#Wf6btsYx67?nO1FPbCYUDX$prTN*yz#I(lp8J8q$dR`+G}K zQf|UUBuxXcj`)zVRA)ICbnDj&gD#foM2~okg;uwnNr-f)J3TR;?HYw9HQZyl*cCaF zgvVq3pkrZXK}AYB_k2M2xi{2Am`BSzzx$MRc>-UGqj1xic}$bG%Ly(SVtp(X@DS>^ zDO~qm@vS+>(FtjBAWv_g**Lx@^6yRa2~abLYu=jlxU8M!GIP$dB_De>T7%>J`53W2 zV#jOdn9kLj^8&b=N=9Cp7{g0cMC*J>V>K+i;3M8Db@(}+A^KC0%CD1DKt(eK@Vec{ZGseM zJj%je$jVQR{r42)89tRZeu=}+ji`fjV5I1K!LgO_26DBTaQtP7CSqsCZ~J-;lw+S< zJ$I90AFq*Ar#mwuhad*ItG=3_=887wtQAkvdq{lL7ubKEGY>9{Bsw`f6)$S1A1`^E zJDsiYK1^*uajL~(NFs0u9OH*?z6SzlrJ17AH%r+C>=#cb=2X;QhfVMHQ%fJjtzShh z)>Cx&YSZ1RD>~5e<2~ZH@Rk)iF5wOgh4ae8XJ(Xf_dq36trm;=qu<6(<%tn22iz0E z_Qh@=1{YZFeI5E%2gyNSGV9VuuX`QNPM|(g{6f3G^DITTmQ3J3KU6$*V9SPnD&5j- zyLS?WCmxn;K4E*rPg%F3oWi&21%# zLg;L#Ze#K@&+{u=50hV!1BPUL(b*G<&P=3{X89!7{4z)m=>Xz75#+aP=p)AiYWiNY zJ#gACdi~+tBFbgaz&CK2%ROi!MJmHOvqllaYIoNjjMDCv_`RO{>%N%>$ks+>etyZi z;#AH&Z&KJGbqiy3^4y|pK%nE>Pqi3Drsn=-FlggV@NJREEM42_F(`k@6|*&rCM*c1US81L@<~==@l88Zt)dCmdCqF-i)7Z(b0z*`H7q+J z8{3Vg_ZdF&2*>kVgI(pfJc50U7YiO_Xc!G!@gpUBwI^#*rKJpwZ5xAVD#WusUyl3Tz;w$Xo1kn%?}i zLbXGM!nHSD0M{xRO>`;#Kg(qLl1G+c(O3 z8oan4qS5bt@{^FzYRMe2^ULTEz9gGZe5ecYzU`BK@}mnsZI@*52adCT2DVrvt_cm? z&3|CWsAcRWIMULW5l6Svk4Wpq#|1jV9buMN>dNJ4CT=>zo@=6)Qj|hjg8VW1yxk{* zi#nO8m$XXvqoIl}VX7gq_k@Q>Z)$$Lsum*|V4tI_&1>kQenBgGJ2ghDxz9i8FmQav z^ZNQ~<;3(iv2F$bEd2Fr8}DH1-cu>M9=tni7NankyX{iTX(kV!tNGCGIG64aW1Yt% zpz(`0#_n3gw=0>iY;ln9@5|F`!?JWisN_Mo!AqXL8AmI~vqd#P|Dbo#bbmx~%2!NX z)G_DDEe?YeBp(|g^q4%`Xx!gD z(h^kTs`TO`I#emXsWf%2o$vL!?(*-=m5b6bt4&?D6$HOnpuO-Xu4aFlkR5D3{b@)5 z!--m89*Nkxa>Ci9^WWAu4l3B_wzxX5T2vjhQEb27A#Vp+&?8E#+RnH{1jvxwTD5<| zRjU@rGreQbIJwPE7fM2F0@xg-l;c5Ju&_Ayp|n^*=X4)b)Albc8?WUnIg`v}dSgN_ z5s)?06h?nh=jd;hL;1aPpDw8^o$0f#mt7wz5_2mF!7aMz%4VBVxXc9*Z31}lVsa_M zc)WR6g(Pyc!a}V%dGKfnDY-74{gCbU%L3B`DZvNps}ZO_D#>TKR(TpWNL`NG;A20f z*i!Q_LG8TcxmM11*Zj{hWI1nBoET2H<}rLDc~oJ^d+Hxjnsbirx*bCvqdgnWwwpCT zu0DSR40H`Q^hcrp`{ewdn2Z5<7d>Z(g-I9gKV%A_NQY1_bSM_?Nx<#{01AOZ!4Mc2 zs%-<&hHF9KP+e6B1P+0WIIRl(k0Bt)%h&tX|2LEin6dT^GJiH$2YH7Q(F81jNF=KJ e2Kt3~qJy#OK?Gd>vYza|2w;Y^G^#T6xceXc*(OW? literal 0 HcmV?d00001