From 2a3b5e4677d3eaed2343b4dcb7d8fade71c90660 Mon Sep 17 00:00:00 2001 From: Jorge Marques Date: Fri, 8 Mar 2024 13:40:42 -0300 Subject: [PATCH] docs: Use Doctools theme Use Doctools directives/roles and "cosmic" theme. Include requirements.txt file with the doc dependencies (sphinx, doctools). Update doc copyright year range. Update pip and install newer versions of the requirements during run_build.sh. Remove adi_logo.png, since the theme already ships the org logo. Signed-off-by: Jorge Marques --- ci/run_build.sh | 5 ++++- doc/sphinx/source/adi_logo.png | Bin 9532 -> 0 bytes doc/sphinx/source/conf.py | 7 +++---- doc/sphinx/source/requirements.txt | 2 ++ 4 files changed, 9 insertions(+), 5 deletions(-) delete mode 100644 doc/sphinx/source/adi_logo.png create mode 100644 doc/sphinx/source/requirements.txt diff --git a/ci/run_build.sh b/ci/run_build.sh index c0e413528a6..92299fc91dd 100755 --- a/ci/run_build.sh +++ b/ci/run_build.sh @@ -84,7 +84,10 @@ build_drivers() { } build_documentation() { - sudo apt-get install -y graphviz python3-sphinx + sudo apt-get install -y graphviz python3-pip + # Install a recent version of pip and the requirements + pip3 install pip --upgrade + pip3 install -r ${TOP_DIR}/doc/sphinx/source/requirements.txt # Install a recent version of doxygen DOXYGEN_URL="https://sourceforge.net/projects/doxygen/files/rel-1.8.17/doxygen-1.8.17.src.tar.gz/" mkdir -p "${DEPS_DIR}" diff --git a/doc/sphinx/source/adi_logo.png b/doc/sphinx/source/adi_logo.png deleted file mode 100644 index 179fb3036fc72102cdf4d9e14be7a94325ba4b88..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9532 zcmeHtXH-<%vMwSyHlRew(M{?m=Zt_LAh^k?X&NMlZlD1{$skF|B0*6=w41oeP0pbk z)F$VQwZ$DItfZ(=}>k|vO z#Uld+h_|O0__vN2!qex*nt(t_72yMhxI^Jwj!+j@FJ+#+rdA#?reeo)h3!zYkncZj?bkE#ln5<=kyz!M4wb0IuEykH6lWuAZFD%^~Ji^X}k{-FYQ zSLXRADT_zOT$u+($uNJTNd&EKpL++s{QDBrh*74wU$faibv$ z3-W@45u#o&-oFvFpfHG^s}J1O+l%WrBG}Q}AFj-EL-wChc>4Ss)(iHpOx@&690B$b z2Z;fHNAU;r14X4xHs&nw-1+ulo*Ih=n)v=>h)W4{~sog9x3Q~!Qfyo2vko?ndb&X z%+=LNK~@taqXB#%t1hLk4gzUwsY}R8%WFz&NolJ~Jdg)T{%xz}4e|Gcdcps;b^32x zx&P7jcR_gi+<4Z4`nd)`ogVmkdvg6FY6aK-z(xLngu1#MNa6-h=09`!r>)cf%thvZ zd$yf>47mp|0&rsn-_irewLYmk6|8=aC>2%!8xAb-n*ChP6YS9gZWrJTP$Tl@alu=P55w1HHm{tT6vFx-l6#P`_Cw6aITe6cD% z6zq3p-k~n$>~^z`Pdld z9z0$u(kqK}x*=5kbmsebNP;ERPO`T0ik*ABLRdZckJLZrQ9q`sQ@(`T;@RA+}!mh_}nDFufAmI@^tHbF+hA> zQg|G8X6LyD7g;X|t^AzLY+)S-?Z3=_zT54Al!~fnsZ^v<2@J2usKu1=K7RX}e*C-I z3%|)B5P%_P2`&Fnl#t~7&e#uQpHbgQWkAaH>5?kaE@X3P6IG%LLp)pm+C0jn7;#9- zkjT02M0lu`K?KlyZLf5;u(>A7VI$}*cRJMSpYi^QMId|pRN^uFU#1rBYA$mmMP()G zX5Qvdk^~t)6zp&Q~{HdD9}RKbP|J z{$hik_A}5r4Yp}T@Ylm{qD_@N@ntcwX}Oxllr%12J$Q>#o91(g)f;MEwbvXZ4yqC? zT=?~kEjq$iSIDi!?kz-<1EjFlRaZ&UZgwoix(_{Xa%_Mo6O?qLAQ^k&OS`0P8n`xN zl62&d^J9vBjrC* zHK>p@t^A}_FO*?uNRG_tNqoz;V(KqPX=X%xTN=6ph;@9mSXfkl{2@p?NsrH^2*p&X z;y1rm=T|X-J~i782mzDMU|JGBg`Z>bm9`bhyxUQk>^1k1$PP-{W)K^v1m z8z+^&xl4WEu8T&%oP(*}S!)we0 z+d=#m5TlU?k?!gJRzS@z>Na$T=%M~tN8D|{LM_2M2XS_>^}<9xufAyyVkuh|tFqX1vB zeoJ@hF=SA0{C29;9~e zi&@S_#V#K%LOPg_>RDT^r(zpF$B{SN8U|CcoGwzZ;kehi zH~UNhiyFU1U%g2XT(dEM{1`{2P%L^l*dQnPCbyfe$??G)KU=GFlAe&PTm^}{$WKv! z<)oQQY^5`%Y3|2KtNW3wT>iyoL!R;GInPTEmeG@mpUW`mQZY9Y_DsB_5>Fvw+Ow)` z{qhHS+aSdnc9e9Ox(JdI0Hd@u>ePSr*YQYAc5=TK#$j#sfR2M#{>Oog?A9BWp?pd! zUToJ&8cfq2X)ElnOg&DV7lfIT0hic-68p6=T>1~uNp~j%?;1tbAm5=2}&y3_s zCr!)Zc(%8KSsN}^ZKiFiYuCF_ZhR(a7y^GA<`kLLF{VYG9W5TV2-#x4jjl04r82~p zO?+TVFUz=#hVL%FHR@$)4AI2ml`aFrl-$g1jK#hFg3C`6tP`mHB3rUiYlM{9H=Ql6!^Z4cfarOLOB?h!ly-P!#b(lEeW@oX8p z*Nlkn=Y!tjV%)Yau=dH}{ZqEy%;T;yvB=M4rZS#irf9_KvAKQUn9k?93!lwO;YpR@ zd=HD4cFI-o0sZ6jHonxUZ=ZVV^AjvZYM2#-4rKnQ8go$yI9f=#FQhGBowPZVtN2(`DyOS{5 zBq3Zd65Sp!OwNfAeS8l0>N{1NQ#(5VL|94?so6pLr2xz@3UwYE4gFwGO;o>l-simUHqb%&xiG^-+o?J}J-Ne?#(O}Uk29Pu@ ziLkeFPVg%@NTB#Z?jISb!rLd43Nbn^eitjf2N~R;8o*|rc|`_bociFajrK0h^& zNg9%OcM!hs34DU{G4k`~<)q)h6OJ?5#8eiNz<<%#$(OygVS#Y}(atus7;13eZDCZ< z0b~2C<8m^%=-DxN?_QkgF6Qi*SD;sn+mUH8w|?nos^!l)e+OM$E&ND|qPR)+`=f5- z$C`04XO)y!K?z=_2s7jCyGU*~oUAv&UXE@@<3W|b2n#sRky9xFlzT_%F{>{aWJLJs&^##**ZwboBkF;nqSnnrL~i`?e8;g?GRFC=#jd|MGo^v#4H4k z(mIZ2XledcFTik%XSm(v3iV_p6I-Z-c^3(00Vb?{n{6Vf4k^=20}nNjbIdf=RrkE| z$R*{Oav|)8D$^Bn^UyT3W4ZDa$Qd-`D`MQMll$*lRgk%7Rp8&RH3UR!zs#u&plmr< zX#BA1d?bG$k$MpGDm2dYin|6S?ZB0RE6>8;b1Y)Hf|yQQSCinBr`<-g4N6VVz2b?P zJ5DCK97XE0L(7|q7)5Wk7!2dyE`9!%yxS|q=UcWgA&XdkuTO$NO_bC^7_9K&Ohv8# z6tQJbrJ^$A(vQYF;;=1(gEdC|)q!6otK^pB^vZ-lem4z~NC8JTj_j%6?->BW*fnixkLHXyIKS3K zF4<#AfGpv$V358qx7E5}#dQjlY@mU>eKU&JyOEa>7f zPp198Sqb-`eZZ~3u9%Z<6Z$#J;C)zNK@W@OQDM(HduBjl=q{@KlP@N97GP45A4k*s z&T-MT04uxJScJwOyNs#AE@PsGP~Q2Izs6E#7{|@7ZE4G_CmSnjY?a1FGg#KcER+ns zmAZdDenLCOHs?%aFo(=q*2_%w&-u9@y5kRneMesCtvi|%2lQD?MWRLCeKa)*s1@yi zu7zb1;*CUtw%bh@k=XC`u#E`~y9@GXZ~s$ljjJjq+DKeGC~{NL{2s+%A;f=%Xrbk^Ezq=hjJOth(6< zOuZSE<)}0c+n9rq_>W4TTBc(%HTYP!9jv+bt_Z+eu!5R}1Jz-T4|x-MS)y|dO!=P| z1r zq2M1GxU+8-xkWw5r{P~2xoZqv9FGRebQ%E+!yS_(BBXuoFYdoNI7@c%r}9@GPn&NU zU2NA{-N8E>y+?S4*QfJ607#Wduf0>s|AN&r=XsDz3K|B*;w=-p<5(G~Bq?3-X-jSa z)BUKh161Vz;l93#pCIqraXzNKa>%068ri8-2Vk@>GFv_%Ea^ZbGL>ci0-KF2aZz5B`03wW>EWl?4E*XP z9K@i42f&U-Wn~Kn~s?V0$G#-V?WKJT6&t;odjGC1)Lb^vPs%KeHaU@}$R#DC(K6Gnzl(kBf!?X_sJ2 zU#97Sur;-MG}ENj*l?5B39tvXKd_yVQqScDrw|Xx32qQ)u+#hb{R^qhaEtd#@owSy z>}{8Nc3Cg4-RQ3*W?~&lBgvS0v7|h@8Y|j-qwbl)2Q!KFjx-|CHNuNFfg%Tf@c@C3 zikz)gXFEdqaVwbuKp|7w?s0&0#IoI*H(f!#Y)X^PnO&0Gd|7&f#9y0>$RYGZ3&cCt6*h>$jB!p!fSM9l6vtO6p`%8- zNxq_h_1j4;(Pyk})*tx1mZ^JYw)Sh|1+_{EWEiZHK`GkpsabsKYW8hKd%PYX1EKn> z+6%HVPs+-AORc1VP6gpv9&M4^MsbLTJOWt@4)2m{aE639I&M1g_$L&Ev3KkA*#xMd zUkYR1gqUzBsm3G3gvJo{`7{Y!F7L+yQZx880!Fru9>}Abt|Y{4YP6?tVE}yr$%Ho9 z#P@?(4*qnpE_^-@^Hy+&9-VY#u+9v^Ay35JHKeF*!2vBcdN)t%La)fYC%4im1uOA0mYW7 zK14!4386Pgn?KxcA`vWqLZ@CkshY+2>8?I3?GMTn7Cg9l$mKbYW|yT|rEjR8M0QA+y3h{E~+s;um#DyxZ|H zPhsO)zay0j^;jDhXTQ;Y{1|zm8&hf$(XtKO zp)1XAjlMHb{?R)^Jb_XcleR2W!-X>!o%qpax^5R1#Sp7aK76yJA`+G!Y2aJ%@fJ@U zVr61%C6!XzxR$%J<87<{Ui(MyPU1rfiw@wO%?CsY)X0v_8ChhUc}A9 zp#>(;!?M8>cVwDlR&45#52vm53bWJF!^|SCWBx6i23p~kRtnR^%G5_EQWnN$NA;l9 z53}xkaDdxhxA0$*laKbSEa2+}&5J6Z<$4<%S#@y~rT5)#4l{Gl4!`#zBTLIELm3Z( zBZu2C_h;ul;y&GS7ibb79|-q%bZl#D4PLIn9>(Io{@KFnlVT7&cNMJmGq4$B473D( zeWkY-yxZvge4c+LObkGjL{k?<;N4$4Y1)v_jWfqmO9RBG^J622Z6jjvfBvyA-TwJF z6G_maO;7u}CUU-sC@FZrbF+bn&y6yY(6OoCE4kT9+?RP0y1mNf^3A$`oj8D zO%`M#%ChrOK4turh6AvQq0>Y}Dzbf%T4~qanh@iU_yJ_-WM)29Vv?_uhG<}#RNU1R zAFJxW0m5`~0n7?4?3ph3IQa|<<)%3EUC;V_ZUG_#KqyM4i)t$|yj7Ss7^cc6Pqs;W z*ZnQ9p`73PX$(Da^f7fVy%WdzGj4YGr|Yb+S(Ee36rBw}@4(F_^OiudjkhQWSaSFS zy;=$bc^tFZ;M~eHtQ+hnxAx98$EZvOv845*=wrUi_LxhvwO6z3|)0K z)C3F~2OA(TchJSxzd8e%S|21OBd!{l#>?+rbh7Cv0{2!{W>XFnMfL4u`xIGCp@@xA z&hoJRZ|+;>)wAboZ!oQyzCWhQ&FzENT(*YMod?Gk^Zpj&_8}{CqtTbVJ!M($n!DG> z45~`#lizKr#V-eqn^P4q>*lBv!#Cp3_SSptmLJTT%$1qf1zq;rr9L~LJmCz<<6QDP z7#N%kz}Pl<2kj^fZ(rMz?dZ2Q?DvK0*wH@qzf+r4^O$1y;Qhs(jqR^ry{YRzf>Dry zmYhFG#o=Mw4Qx6C?w+Yzu<3>Dq6eB$NdY$`WeV0-5ApL}D(sgtv3pm?vRf1-l7Zmc zIW#PR&lcEU$B{)gF`{GX>h0z&^RQ02vrK!e`zk~GbNZX8I|BDN#qo9zH-Ey6>^c3F zvHBr5H{T=JY7^K$k-G(myvMEU!l_QE`2*2Hx zID9gT-^K4S6+A!NKbP+9G)|7U5^>Zd{z&;H8%M`LDO%7(68g*#$>gm2yVZy{qTOs) zP?qFaN9>eJx({YlO*d4SnXtc<4eEtfL^7QglcDOiz9#sGt9QQk`(8FDm#tmNdXBy~ z!OJm$<{EGNMz$Bf#k$xk$^7CRDAZ~>Yr%#S#J}X9sLM;NR|RL>_GG4!Qn7A2WN*=L zI%L@DAS-`lFX_9aavx%0x4d*jdO~Dz8o;iUu&;0|s0P;;6fYZ`pK8CHVq2pd1@-9Y z*>`W&T)7rpua#fBT`D@f_7h)o9qI=?mZYnW$RO(jARSF~3_iCvvVv3uBS&nyQ$so) z-rBsykPqWxOlPZ;gg-a+Ug=qlA9T<$grBPN=HkN-9ie`?H~m~pE5{4n>WXL$a|KwD4DsG-Tx34ko;``0vlAY#!#7g4* z1HMz5`J(M#UA7u8xVCx6mpd8zAw@zJ1?ES*%=7#fEhthA4F`F#(>s9I=W1bd)T^VuZzIMC3==I8|%SiGM z-p?yl=nWmZ$~z9%$WU5WB>FLXDL<+~-~zJ2de2YR0xB~Twty*JoL4Wk&?k&l{)?Gk zvv1w2B~{QQvHk-0&)?#tHQpB~EgC2|y})R!Fg~)$|}lT)s|LzS?Sy# zB6IXtdBiiQ?;xPTzMtjr4b>sSWO9_6q6=cTgV$~&G{g>xcpb+vKGrhL~itfVONv{O_7m(5yqo% z-Gw;^h*jQy&zp8s+aT%&)|nf^)|1;3YVcYkg_TV5q={a?ycS3{k1BIv4v}j*3C9mt zifyF-&S{2K=rbk*B@d0oc@zgT^RMSZK>6>ge=;WH2%>!m75~CTz-Z&YbOXuW%zB3{ zw|64BSd<5?2pJ!{UgYpc)dPi4^F9UAOG@cXCvWOmERBT4*JT~IQX4g?e4Ecyc$g@7 zFYBb-->|v_aO}#vz|%)c%1yG~e=6F{RLR*&m|lo0B6;#;gOycE&CN{x^lAO+Mh<&F zPxo_%-qH?|Ubjk#*{Pv6U@=IaEOIJz;cEGUGJ3L8fk;xwKWu|ymlkm~tRQ*fRoK(I zy7a8H%I9MXr(Fux%inNdPT=#Df3ky*Jzq(mu9XbkLv7J~J~|z(*b6BW^($^*HVU1q zYNO)#{snVON*{M3_|3!Wf(BpbP;lb7L~;2pkNe{fX*s3X;Snlo+jLe*IA=!;#q20h z+kWX=(S}3{s(MAiw(Mw(ON4DJFLAR9g=emc!)_42R!v0-KBAv|C-Eradu;>%N zqfz*bxWJA3USK4x{MTV{`$+}*e#cQNNIP!l;(n$4;ibljB=LGBESmAA-=KzzNKQ<- z$Jv83d#o$;*HD!28xfyrL7!QjIArxo#Exk=*0avgvv|NQa7}?;lfB18+Aq!S?Uip9)@tJ@iOE&Qn{6d9_s__(oHo znpy6&?*P2!pEP8CAME17m^^p~+rfW3F+?gbCwZ2iP$s*=aLM2V!^LqtYfF^T;cWL9oKVx#C`UY57X`(F5g zJy~>8RnEEtgXjX`?Q5oruUQ=qff^hH-GOyTz2T-dVA6H@9=^mRV;O}nf(zTyvWT*Ix zjsDI93p)Z{Jc?F*3~z^$D44{(jH&1%?0kbyyi;b)`X=a5+PI`yaAc;#gN#u{(& zt-iYJP&Qc>3QsQqh{HsiSPfUD1hauJlAoCU%|s%m9t7u`0a+Vcy{)K*p(Y&3x1bvy zoD7CEiy!Iee@1^BvZa`Mu`Yl)q+FcuV>ASZ8mHtc`rB3nBxw`2FU>#tq_M%9E9t?j zvVNXo8(BYZA*VWC3M#GXm<~G};GD1ORYzNPb|q4MYiuu^hX7MV102@15hlZWJtJyA z>y(V&R!4QX?<-S&E8fR`*S6W6QH~s?JOS2z2=c#|dEXyZc1Ry6o6a|6F@h5!@VufYuzXR2&6{(%yU!YtY>-5r_il zulnTW05tx3q4kLD>m7P&ZY@(?Tom9D_hSYPsp$U|{%=D5Uy4B!X?9KP9((&%lD#VZ Q@4u7uv<