From 9cfb3ccee39c43e9326b26647596ac3b15abc0f7 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Mon, 4 Mar 2024 13:26:20 -0500 Subject: [PATCH 1/2] RTD integration begins --- .readthedocs.yml | 4 ++++ docs/Doxyfile | 12 ++++++------ docs/conf.py | 43 +++++++++++++++++++++++++++++++++++++++++++ docs/environment.yml | 8 ++++++++ docs/index.rst | 0 docs/logo.png | Bin 0 -> 10788 bytes 6 files changed, 61 insertions(+), 6 deletions(-) create mode 100644 .readthedocs.yml create mode 100644 docs/conf.py create mode 100644 docs/environment.yml create mode 100644 docs/index.rst create mode 100644 docs/logo.png diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..01c5cfa --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,4 @@ +version: 2 + +conda: + environment: docs/environment.yml diff --git a/docs/Doxyfile b/docs/Doxyfile index d6509e6..05193d9 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -6,9 +6,9 @@ DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "Oh My Cal" PROJECT_NUMBER = -PROJECT_BRIEF = -PROJECT_LOGO = -OUTPUT_DIRECTORY = docs/output +PROJECT_BRIEF = "A pipeline delivery generator" +PROJECT_LOGO = logo.png +OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO CREATE_SUBDIRS_LEVEL = 8 ALLOW_UNICODE_NAMES = NO @@ -124,7 +124,7 @@ WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- -INPUT = README.md src include +INPUT = ../README.md ../src ../include INPUT_ENCODING = UTF-8 INPUT_FILE_ENCODING = FILE_PATTERNS = *.c \ @@ -190,7 +190,7 @@ INPUT_FILTER = FILTER_PATTERNS = FILTER_SOURCE_FILES = NO FILTER_SOURCE_PATTERNS = -USE_MDFILE_AS_MAINPAGE = README.md +USE_MDFILE_AS_MAINPAGE = ../README.md FORTRAN_COMMENT_AFTER = 72 #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -218,7 +218,7 @@ HTML_FILE_EXTENSION = .html HTML_HEADER = HTML_FOOTER = HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = custom.css HTML_EXTRA_FILES = HTML_COLORSTYLE = AUTO_LIGHT HTML_COLORSTYLE_HUE = 220 diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..e6b3cd6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,43 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) +import os +import shutil +import subprocess + +print("current directory: {}".format(os.path.abspath(os.curdir))) +if os.path.exists("html"): + shutil.rmtree("html") + +# Update doxygen config +subprocess.run("doxygen -u", shell=True) + +# Run doxygen +subprocess.run("doxygen", shell=True) + +# -- Project information ----------------------------------------------------- + +project = 'Oh My Cal' +copyright = '2023-2024, Space Telescope Science Institute' +author = 'Joseph Hunkeler' + +html_extra_path = ["html"] + +# -- General configuration --------------------------------------------------- + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] diff --git a/docs/environment.yml b/docs/environment.yml new file mode 100644 index 0000000..fed35ba --- /dev/null +++ b/docs/environment.yml @@ -0,0 +1,8 @@ +name: RTD +channels: + - conda-forge + - defaults +dependencies: + - python=3.11 + - doxygen + - graphviz diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..e69de29 diff --git a/docs/logo.png b/docs/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..c7f7ad5d14beb6a905624c95dcaff9841e630a9e GIT binary patch literal 10788 zcmeHscT`i`)^9>63M$xgviMh#tR=paP_g%ARSE(sw-!Jq;n(n1kY1QnE`fOP2~ zO)Mw~QM#bgr8jBc20iEAGv2-Ly*tKt|2r@iYwfk?oNKP%ta}h{YOK4LorfI+0`0}< zX_*5v4H#y-Sb@JhcDWkB^d5f}&MHuARx{7GlM3 zD7|r2Y%k_!#G^qQpBdcq@xh^|IoEQ8b_LNCloTY(^}@Fd*rARp3O|}FE=5=P(@bHg zx9kldqtdq)!qUzKIgT@jgP7s8;|ncskl#fl!=r{L1XQd0wF9h1h*zRiWnB=p;s=_O zu-y&34XC>%bpfdgZ*CUoUp7|8wzGr_zR0DlH@z4vs71YWM$4M;i5=nad|HH%O6HlB zxv14iYCVb+$hlXl;QsBTdw*OFJify^@r5z*(C$-?yANndWInu(^w1)7VxGr5+@P>+ z-I%!Dk`a@`tP{mzk)}c37`!r5VJoF3J0==3q|S&KzI+Q@cRtOGcyAilOt=TybQ#q5 zUX}85Sc+S)F^J#;Z}ikQ`Wc*AqP^yKSa}s=^f_T&CgidJMeUJyE7P@7_331WEm80Z zr+RX^em{sUtd&u1rA#0zB~~tPsW1!;6Tfs0i=KMFZ>YZJ4mo4hhL!Mffb>N1EQgcp({S z8EH6Fn?fKXg;m*wlzp9?(dJq@zeNB~D#ETLk`EdN^Y{0c_D4y3`?|moii(ObI1+|L zLIDaWF~Ez2r9i!iC$>fWlA(ns;(Q4{B!ah>(6&shqqiSPMOYYkFZ73go<2rKe~R}a z{zd`714hC6z!1`Kn5QS~pE-ymZ89L_w?hAtgJ==pgNK>piQay`IJ`C)??pQCR}tp; zf86Q+Lj*wn7XePVKNaxt^Yz%l!wCn&d*D5RvxtD&h`;E(9kPFNY-8v`@buZ?0<85H zN)o~O-)Oe|W(SXdz6rqor`&&ej~!xw%E$<<<&E>(Ru7}4A`I+EI}x1Fa1AX*IYl^1 zK@OpfKxoS+!ENK{}%3;PMJiP-kbj3{(bC0g6?C z%R=!^NSv&k3{nP%m)Q~JghT6i`+8ylA0T*QUGOj;FPEJc+aRMgOff3LNar!OM^G4^j()C;kixyNw`19F4M<4>{2kdP93d1w_i@%)+!?8WkaL7$Q8*M-MiK7_Rlp&gpn%_Ek#dSSz(bw? zs`UTD6@h{-|JN%j!?ttjA4XM%{hwz4?Fm|VUjkrL9ba$H9g7o5KpsOo{rfb4_`jwB zz$v!*|CRB7rxEzS<=?T+FU9|00&(xh zXlYnbx~EbCE?agMH`gfb=Gw*l{&YU=dNwn=GK)s|p{KjfHiA8$K{)rb6t_JPV!uga zaiX3)@>MckgX^L?7Z;0$wmV;%u!LBQx}K|0a7_4~>wDyvmp5BfD>ch7UP7Nf`7=i1 zOn!XsIOmdA%qS9nxdn+i#7ttNLT*F&gGe}}s=Qb^ zI2RlWDg})|;^X6EQc~VN$2ChxNTg+Ejyk1?86|UdW$u5QEdL~6{yQ@po6@=PTH9KE zoS_E|JTCWz7xa=Q9vtzywN(#;!TQ_r4Q$Oo>NGTpwmS1}+_)j6tbDHti@p9aNB81I zM02#DxVU&&QIX6(J_U6OMWL_U?-8y!s>rRgHK5U@_7v{TV-Vz{%FqD#4OrOM*Y{J2 zC$D`|!}~%PlXAal
vMAMduG!%;8+T8HyD^GyDdesYe3ECLS<1p^msCP`5dlq^aVTbnN=lmP=!DYa;u7NH)8pe0eRFcjdHVEeEA>L2 zbx)}`qwL~vkxQF^_-b0Z7x?f@$H6N{;Brz@5w}O);RpQ~7dtJjEp7TI7U^_)eInFW zueUUs92;A7^M+6*;S3Uq)H5*=hsq{g`0znXSGS`8|60Fij-veZLRIqBt4yK$`1Ln_ zE*j9bWSS~@xf4h3&m5=A>6@QEeN{|({+2J1n8WviKp;@b?IO=ERN1Vqu39FlTwck) za9_zf;s`Xm#KY0?p-v=E#^lpem^po_g!%)b!MXz`RlmLKnXT;fx7(IBHZ~b8QQ_eq zuCyg*3^zwJ^roLYe(cs;b`k9}sGjg`Zhl_YYw~PHMus9LnoYv*2e-o=k-&{bhE18z zgUSou2@L^T8_UJcZQmOWbt!OQv)?Mt-jjY+SIvM;(jYL*k*-wO`1)y$+{VR zVPkny&0d))}eEUWPt&Nux-pq|O3lKk=g{NnNI^CjIY7#A| z3!`R6N$>|Y?kX^t$(bjHS&5kSkltRq$SXg`+9&-u@!sup=)LUw_*%6 zMx->~op9V@?OddB`gB$Yu9eN_R@}oRxjpzeJbP~G{R2(A!~Ewxm5!b#?XMUfiXqut zh!Zoq5gonE5q$(|lfQV^dxlyCGJxzcB_=^+l4RYj5{_Ru`qI?S&hYFb9o6}`xVRUi z4i5+(1Dg*ml6^Z0-R~& z>grk?Qdm%swA4#9eHHIbCYM}_)$Qaz$Y*G59Mx92vO>8}8QNXbtvFpdf417=SbST> z)7@~|*3g#nV5Prx?$_ljGisS+qnaRQ78c7^p<{RM1Qi#052zLt7Md6=Q>*N#pYd8c zIzJgeI#S+jIOvpEQ%alw}S56seIw6UA!30uhdkj zNNjoiRs{-EQ%kkqoVzVs|HL})!l}S1Sz0JPnU%X%t!!_a|8)QL>(@VKI)-IRL(r1O-i8T_sppSb(H+8+M4mhzep{c>OL#$%L>xSa(g! zZ`AaWU&y`%K{#z;fg~&}%)`o^Mup6%(b8Zz$Fhy3p0>=$2by68vyY;Uk){_e2taL$ zgb;|>7V;FgT9C4ah6Y7hpz;E&uC5NK8mJ#xPs+Bc*Yu2xM4R!<)T#?Wx@a_jRgrX7 zNTctA1+T2f0_6hTIpSx@Lh>h(jTUPlDHWvS(sGFa%)YEGZ@(>O7!Vk_{9*g}(PNUp zrfE&kM%)h|NFD$s#N%^8$iZ9{2(RjTOfZDaJnupks$N`1=3||xL@lUOlY@3JBqX7n zv{}1xLI=Lye@T%tBgE1iO~h7^7bX~-(aprFhMA(@#H@6@&~3#@mfQoe*7U7^f7KQ>Gm_vgxLS5HVq+@LXMYI9TD zRP2uN8>LnUo+~9oj~zQ^=le<&FxJW`LEfXfPEI1vpFeMCY`i#C%xHh)Vv<`q*IGC| zIXH-BsQFnkwaljSL#7Om0~I&Q%nWdRiI79(E3ane#RkD z`n*1nmR`)iQ(En*5Bcik5_c!IPM24H?ni4vLqkJMY;4`$YpjS%OCHqaA4XX0aX?+! zrM19d#>BUJ4j8iphaPPl%cfrF{C0+-?BWqnu>n-^wL)C;J|Mem0Pe{D@Zo5028VT- z)+IYTzT?M_i>pM-x_7}nKIPl2rro>8=OR{cN(h`?nzXf>613JcU=GwSDbJ;`jxgEj zDqRd_H^|J)EXp$I08ng=jgJCl?CRJ4!E_ z=dpUF=}L(D+R~JXyONw-qSZ4SGjsF$tE=-bfK2H&h3m?*Hvu{ob+>KiH%n7Jg>;%a>FFZ+`udsnHRMDFCpVl{R;KXS@V?>c(@eAS{d&Mb;cH9JhbyKjiwV}0l~`TZ z4-d7U1?mB4miCc(X-AWeI)Jtu1mNG6)HV?!C{$q+ai$Y#P4kUgH(F{3RtELGTY^nZHK5@33M3|bm{l;)SJQL+qp1%4x0W)Al4?(pJplS}7W zDixg?^iy(ncGiwMmQm!@5&F@yXS6$m0|;mYkOQ6uOsml8ap6%>kG%(~WwM=uvua}Q z-FpMX8UHdY->>qqkmNM*K*g=jxiP-DI61k#PK2tKdc)2YXhj@_bva zFOt=+Y)almlbag}KNrS;1}&~_$`MvMbJhN?=8t3Og|Fmm<)3QQ!d}oAHbt%)moF;^ z1O&+D-iwcKm^^Bqer0R3*MA_e$cs4MI{E$WU7%*_0a0N5n1zk4V~kPrJ?qK+hd_^O zn1T$k6P$qLTmv$+&-BcfsM+PUS|3%^ZZ7j`MR{wK%bQH!d1vk2GcP&STz}kCwDc0| zs|+Z-&y9NAswo6?bTSv~neoofKcV28H*d;ZUhx^Z=t85rG&4u*wRac07rQg0Yq$s1 zeG9&?FXma^7ZAo=TK>`bt*>0M=Y>=Vkjw}`?gZ_owGn{W*XZ zcmC%@-h9PGp18a`1J)NfhQEFBYfJ37u7N4neyDAM--MO%J%ulYZ@#q1E^g-tu|3`$E1$FcA3P7+~{a(K#2x)ZDjsIK{c8}?> z{p($MJ!ug@sn?EH`I%Yb)t6maSy?Dn&X}+SnjGMq3`DeAZs6Kd$}LXJ&yKbi1Dk!) zw{E1byWPI8?gJz~?^E{1l#a)}qz43gb6h)0pqin3 zjtdJjrR_S)(d&Loavxm14|m;wrk%K-hiS6AI0EQCpUWQ)&d-OJlc)5xa;#)LyW?5+ z@|ap!XpzZsZ1lL##qLLeo`W>ep8|%kD(qLGopLw`ujeKT3;9o|o?yoOgkfgs#vLp` z&!%r+aK^?aIf_qlXkxM!iMd1HJU*6urCAlZ)y6$^+5ryVb%W`ow9Fx&t8;5KRc6&a zT60WXG!U~82)s)j^v81L_S$@;$lGTk(>UIRRU2~@MoJWK@bgJ}*!geHm~N{FUIx4i zui{8&+cU@yC3`kE`YcPTq*QF%k7JfC^f-#Q1WWvqEm{QKJN$e6gPfyVblW@Sb|tu6 z^lcv~AOz5z%Vsb|obp_eP zmvD&LkX3+n94uN(#l5NOG$) z)92PpEjwo;MKi2Qgl*dK^!`QM(5d#^;pn`{TrrHbb#QY>^+`)%@R2n=dzU9JJ^DyF z&ui(6OUtG7P2KjlbY;4uXqCtOl@ z@8qbDh_T5au|o1N?$#}YsGN8Dl*1LPdnNgJPU||Eb4z*h@R&I+5_l#up&^o{8;K|= zI|O-mXZ43>jC}#UTQP9l#-VCss+T+)704L2xE2FBe|{`b#LpKKK0ldi%VRgC&q@E< z?})1HwCc&$sc~;uAa`z6RLR%Eb`Q1}`k%wV>-1@SIlAKdZdjP#J?v{tJCv^KJ3+C& zq)6|N`S{sb-dY@t^!#j`fC1edIA@+@LKtQTU_G30=AxrMEI?V?syi5O}}_t_}@xb$7REGuat z_9trtCXu0OV@!Di6Q)$^jHq5*3eZ`muGRzV&dS--Ue-8D;|vQ^JhlfH5%%9vS|)EmrQJJ#0i%| zMqbf39iGkVxa2S~`H<@lpBQ7uGq#NTJpS=WgL_YvAw*wB@ibj*`cp?!tQfMQ&JN9x2ocXmMevBrvxYs+;QS# zNC)({=J(<@wpao9-ZGX^#~c^)AnPv!w7ZdrJ0))`f~6u6S4voWI^;|(oc$>7ytMk8 z;}v!*3ngwYNqcqnBAP@#Rp!dI%wL)atsxNRc(}lJKYkWP%5g1=!LOdNMg?LUH&mLE zF7p;uyf43c`$a3Xz>ohEpT+K3I%qk!3spVVN*>}rOs^WzyBP`5>CUusPs>Vo9W=@2)i+F(JHoPX%k66=|2!)KtfejRZXG%9d%dS8hh#M zJyaHP&3yX(Wo(wx%=x_@w5Y=y1dNf?k8HHA*C5YCYcV-19ws{FyV`5?)K(ND-@UTN zn=6+~(uSrM63#qJIp8_pdqVkiyQ6#KTK!^lR}}{_>J)vU_-#egW0syz4HZ_0@3QCG z@vg1iNRM4wwtn~OL{}nxc*20H+wQftcH}OjyR$zfSI z|ECW+*+2D?M+z#RSWEDD?5$6Xx=|eJ+QaUccL(+Si@0HF;&PBfmMGQV;W<$?HFCi+ zUY%jkjUArbcZ;b>-!~`MbubC>9eVq^fxkAdzuwQ@XgvZ9b2u;B7W*i0ZEC&##r0!H z7_rB@nip)WUF5zkcZZZUZ0?>EjS5mP_xm;u;WQ|3zIlJw?a{X4xI?!gW4UE|NsAx) z-n8?tC{<;dVUhZhF?@n)+DusdX?r{x{b z=AVs5fdzcNsP>jqP{DY5SEqxvFLv)ShvL91mtzoOUE>lX^vZcDuB{;4n;^B_F%Y}) zImNpcLYt`C##%--vmW#l$QoSNlqA_D?nQ8^(|OS_9HM%I(!yPs`w+{n>@C_2k;dhO zr-w_oWyQUf%J=k`d6Zhs^xX#6Q5Sd>PZs}fABUPdIC({UuDdl1Iutr}gmIlK;=TBi zW+=Go6oL$rx`lY9%9AvbOj0oYK#M0m-@9bzd1p}9Ap_wY2JPz6*_BfGxr7I2tYz$u#ttyeCNvR^am2?OSUhU?w@Sk(r!OdyXGZ7 zb7O5d=gXjXc5)}G>5!SK_@>)oJo&5`@yQe`c`f*~WVQEDH9w`@X5F6$C-?b--?5pr z;udSLE-k#v(vGR9aB-fdDF^EqB7HJ`)BDx2fP3w7eV6xyWADwALS5OR2YP;}@t5`t z$ujnpdCA?Rf|9;;6BRxTg=Dmm*DgIcAqvzw@<=;`TnhwyrRVELYggPuCFE*Ne8lZA V^L7UC&jSz$qiw8}d)ndZ{{WR#G_L>v literal 0 HcmV?d00001 From 5911c460a3a4d11dc42ea57e31caa66491f52819 Mon Sep 17 00:00:00 2001 From: Joseph Hunkeler Date: Mon, 4 Mar 2024 13:37:58 -0500 Subject: [PATCH 2/2] RTD config --- .readthedocs.yml | 11 ++++++++++- docs/conf.py | 8 ++++++-- docs/{environment.yml => environment.yaml} | 0 docs/{index.rst => nop.rst} | 0 4 files changed, 16 insertions(+), 3 deletions(-) rename docs/{environment.yml => environment.yaml} (100%) rename docs/{index.rst => nop.rst} (100%) diff --git a/.readthedocs.yml b/.readthedocs.yml index 01c5cfa..aea6697 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,4 +1,13 @@ version: 2 +build: + os: ubuntu-22.04 + tools: + python: mambaforge-4.10 + conda: - environment: docs/environment.yml + environment: docs/environment.yaml + +sphinx: + configuration: docs/conf.py + diff --git a/docs/conf.py b/docs/conf.py index e6b3cd6..6610bbd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,23 +16,27 @@ import os import shutil import subprocess +import sys + +print("current directory: {}".format(os.path.abspath(os.curdir)), file=sys.stderr) -print("current directory: {}".format(os.path.abspath(os.curdir))) if os.path.exists("html"): shutil.rmtree("html") # Update doxygen config -subprocess.run("doxygen -u", shell=True) +#subprocess.run("doxygen -u", shell=True) # Run doxygen subprocess.run("doxygen", shell=True) + # -- Project information ----------------------------------------------------- project = 'Oh My Cal' copyright = '2023-2024, Space Telescope Science Institute' author = 'Joseph Hunkeler' +root_doc = "nop" html_extra_path = ["html"] # -- General configuration --------------------------------------------------- diff --git a/docs/environment.yml b/docs/environment.yaml similarity index 100% rename from docs/environment.yml rename to docs/environment.yaml diff --git a/docs/index.rst b/docs/nop.rst similarity index 100% rename from docs/index.rst rename to docs/nop.rst