From f30b232956ef780eadd783aaea5c418c0cf2b3db Mon Sep 17 00:00:00 2001 From: Laryssa Abdala Date: Wed, 6 Jul 2022 09:48:30 -0400 Subject: [PATCH 1/5] feat(documentation): Pin dependencies --- docs/requirements.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 83debac..7968499 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -sphinx +sphinx==4.5.0 pygments==2.11.2 -myst-parser -pydata-sphinx-theme +myst-parser==0.15.2 +pydata-sphinx-theme==0.9.0 From 22f16519bbadba0573ef1f0b7e83e68de7e62fdf Mon Sep 17 00:00:00 2001 From: Laryssa Abdala Date: Wed, 6 Jul 2022 10:02:45 -0400 Subject: [PATCH 2/5] feat(documentation): Add Read The Docs configuration file --- docs/.readthedocs.yaml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/.readthedocs.yaml diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml new file mode 100644 index 0000000..ef449c2 --- /dev/null +++ b/docs/.readthedocs.yaml @@ -0,0 +1,25 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-20.04 + tools: + python: "3.8.0" + nodejs: "18.3.0" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + builder: html + configuration: docs/source/conf.py + fail_on_warning: true + +# Optionally declare the Python requirements required to build your docs +python: + install: + - method: pip + - requirements: docs/requirements.txt From 032affe252eed42bb6c6068789dca94014126bf9 Mon Sep 17 00:00:00 2001 From: Laryssa Abdala Date: Wed, 6 Jul 2022 13:55:59 -0400 Subject: [PATCH 3/5] feat(documentation): Embed jupyterlite --- docs/requirements.txt | 3 +++ docs/source/App/app.md | 21 ++++++++++++++++++++- docs/source/App/test.ipynb | 1 + docs/source/conf.py | 12 +++++++++--- docs/source/index.md | 1 + 5 files changed, 34 insertions(+), 4 deletions(-) create mode 100644 docs/source/App/test.ipynb diff --git a/docs/requirements.txt b/docs/requirements.txt index 7968499..8d4828f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,7 @@ sphinx==4.5.0 pygments==2.11.2 myst-parser==0.15.2 +jupyterlite==0.1.0b10 +jupyterlite-sphinx==0.6.0 pydata-sphinx-theme==0.9.0 + diff --git a/docs/source/App/app.md b/docs/source/App/app.md index 4192e0a..b56a8bc 100644 --- a/docs/source/App/app.md +++ b/docs/source/App/app.md @@ -2,6 +2,25 @@ ## How to immerse app here? We are able to immerse an html: - + +<> Add jupyterlite directive +```{eval-rst} +.. jupyterlite:: + :width: 100% + :height: 600px +``` + +<> test of another directive +```{eval-rst} +.. seealso:: + + Module :py:mod:`testing-directive` + This is a test. + +``` diff --git a/docs/source/App/test.ipynb b/docs/source/App/test.ipynb new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/docs/source/App/test.ipynb @@ -0,0 +1 @@ +import numpy as np diff --git a/docs/source/conf.py b/docs/source/conf.py index c5abe52..eeea5e9 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -38,14 +38,20 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = ["myst_parser"] -# 'sphinx.ext.todo', +extensions = [ + 'jupyterlite_sphinx', + "myst_parser", +] # 'sphinx.ext.viewcode', # 'sphinx.ext.githubpages', # 'sphinx.ext.intersphinx', # 'myst_parser', #] +# JupyterLite content +jupyterlite_contents=['App/test.ipynb'] +jupyterlite_dir = "." + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -112,7 +118,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ['_static' ] html_logo = "_static/logo.png" # Custom sidebar templates, must be a dictionary that maps document names diff --git a/docs/source/index.md b/docs/source/index.md index 45676ea..b3e3d3d 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -10,4 +10,5 @@ Documentation/documentation.md Examples/examples.md Contribute/contribute.md App/app.md +App/test.ipynb ``` From c41a0b68045e762f4068429a50fc4707e0af4bca Mon Sep 17 00:00:00 2001 From: Laryssa Abdala Date: Wed, 6 Jul 2022 18:15:52 -0400 Subject: [PATCH 4/5] feat(documentation): Embed jupyterlite --- docs/.jupyterlite.doit.db | Bin 0 -> 20480 bytes docs/script_build.sh | 4 ++++ docs/source/App/app.md | 19 +++++-------------- docs/source/_contents/test.ipynb | 1 + docs/source/conf.py | 2 +- docs/source/index.md | 1 - jupyterlite/.jupyterlite.doit.db | Bin 0 -> 20480 bytes jupyterlite/files/test.ipynb | 1 + 8 files changed, 12 insertions(+), 16 deletions(-) create mode 100644 docs/.jupyterlite.doit.db create mode 100644 docs/script_build.sh create mode 100644 docs/source/_contents/test.ipynb create mode 100644 jupyterlite/.jupyterlite.doit.db create mode 100644 jupyterlite/files/test.ipynb diff --git a/docs/.jupyterlite.doit.db b/docs/.jupyterlite.doit.db new file mode 100644 index 0000000000000000000000000000000000000000..895b274ffe3b142a9f094ffc55d6562abab32abb GIT binary patch literal 20480 zcmeI2&2!tv6~F;5{h<#M_KY>E-LVbR2PYi~#0NnDY%{WIsjkLSELw78*^!wAun=KU z1VezbRF~}-cI{q!O?v3XryhFhB@<6hIp-Q*a>*Z%Yuf2dx&R3Y7G+B$)l91{G!y{t z;=PC8?!JBdmJ7vM+e577)YqZMO4KQerm3qeOHtGr{5gg{(Lv*jWORei!To;68H$^D zm14f963i6EOfg^W_W&s;1PB2_fDj-A2mwNX5Fi8y0YZQfAO!wf2|PYYpBNn(p&z>* z)GNqzY%lmEuHBlRT%2YXCx1CR%?97F?+miL4iCC(CEH{@wCS-`2Y(us3R|n&>#)AX zuA!~5y&o~52iXU%Q+=)Y-7AUXqdy;^DZ6T-P50vpUfY*o!*jy>QeZ<#2>t`i@?^j> zSm4vlKf}w`DYzsDAwUQa0)zk|KnM^5ga9Ex2oM5<03kpK92o*h|K?zNlRB50JDGmQ zY@|L<|2Fk6=5%T^HJAEx`Y-7p(tk>yNiV1Wmd>Q-n7hm+=I_iW%-88Jn2Gc^sjrU= z2l66>03kpK5CVh%AwUQa0)zk|KnQe8;AdbdQFC0cq&Mt}S+J0a>d-@G32*MAs%tw{ zw@`zgQKnZegPC|$!>QsLo?F@5_Z-03PDBNC^V`yXsppN1bbnG5!z>3iwTA#k>>l)iNVOwy5%NP*MvY7MVs+V#^IZE^sNg!<{l zK``2S6M88PE{5vD7o&~vHb5F0bAthwV#d(L072WZ+LmM5CMvYg^gQ!B>H?UEie2P+ zc6HS)I2)*5#}!?Aftfi4F1HZ3gwVICP{Vc`(#z+;dy$Ckwuvt2_s;<(Ds@qP18uh- zJsUF(){U}_3)^S96tqsO^!*ID9%&8u z7djh5zXFO;m7RXmS?|MCa*;ZoctxdWlPT~S$R=J5{1E@6K7Qk0x1*y~KXH!MdwY^R zbua?SMf&)`Y98fU3;z4yy=L1t#70@m&pyhOHejWJ+)^P^U>`Nd*o;v|#u};z_nEmV z`C98XgG)?QbAzw%tu!B>@aK}+Rnxx92 zrCWIsiJFQhWka?g5>+*`5}*DvhiGZ3wHDgL;y~q(qG$(=q)MEm3OPX%yFk;VsKluw zFb2pg91?*i!s+DXGwIE%{sZ_DMKNVwF-$>_1W`bug2$q4YKFvHP!@I6pD*EBUZ!H} zS)9HoJ5`BOvo2mjj|Z6#xQg6pKnCmT`1Lrf)y8>F;P`PJd5{x$&RhM>wtEo;MHaZ6 zEaxTcSJa%8!vTHZU~(qZ6xGs1LlI3?)sSW6tej-!H5uj=r8@_6=;p69Q$sJPGvFaL zR2&)@{Bp25I5zO@z;ov1iBC@~9Gg#m$E>7ghyOABVz>kz4kw3R9#U5!VhDl%X9B+G z!=&(sna=d?N!FKUkpa=_RP?$oT5JuwCELg?Me136Guuv*(+L_@{J&0k8SSD z(cJNMa6K}4?+wLXEx+b}1kQ&R_S0>Oerbp4uFce5Et~i6?`)sEzQNk7$fqfPCAswc zc5Lo{^G^V}Qqr&A?kYtl;}jVV0%RWN$uf!{YocOUDo%;XI5~zFwuYivc|$Vul8&VA z7O=fU0Ue=PsPYhrMBzrKqHUipzn&pGAerWh{~;(w18XO*+M%ecz7X^5SN$b0+U#rW F{~POqI9>n% literal 0 HcmV?d00001 diff --git a/docs/script_build.sh b/docs/script_build.sh new file mode 100644 index 0000000..9ed8b4a --- /dev/null +++ b/docs/script_build.sh @@ -0,0 +1,4 @@ +make clean +make html +#jupyter lite build --lite-dir ../jupyterlite --output-dir ./build/html/ +jupyter lite build --output-dir ./build/html/_output --lite-dir ../jupyterlite diff --git a/docs/source/App/app.md b/docs/source/App/app.md index b56a8bc..8a02f31 100644 --- a/docs/source/App/app.md +++ b/docs/source/App/app.md @@ -8,19 +8,10 @@ height="100%" > + -<> Add jupyterlite directive -```{eval-rst} -.. jupyterlite:: - :width: 100% - :height: 600px -``` - -<> test of another directive -```{eval-rst} -.. seealso:: - - Module :py:mod:`testing-directive` - This is a test. -``` diff --git a/docs/source/_contents/test.ipynb b/docs/source/_contents/test.ipynb new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/docs/source/_contents/test.ipynb @@ -0,0 +1 @@ +import numpy as np diff --git a/docs/source/conf.py b/docs/source/conf.py index eeea5e9..9a8512d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -39,7 +39,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'jupyterlite_sphinx', +# 'jupyterlite_sphinx', "myst_parser", ] # 'sphinx.ext.viewcode', diff --git a/docs/source/index.md b/docs/source/index.md index b3e3d3d..45676ea 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -10,5 +10,4 @@ Documentation/documentation.md Examples/examples.md Contribute/contribute.md App/app.md -App/test.ipynb ``` diff --git a/jupyterlite/.jupyterlite.doit.db b/jupyterlite/.jupyterlite.doit.db new file mode 100644 index 0000000000000000000000000000000000000000..d577a024edbd3b449466057476985463683bd24a GIT binary patch literal 20480 zcmeI3Pi)&%7{Hypbp5x)NT^Ih47?065Ut}sacqY_rK}xPY!YP?e*`6R?B~|48@usK z+ic6AOdAX&#Dx=x1BesSj{Ldp$_WV$j02}haN&Z)0SO^^cH+iOO4}rbP4qc(ZRb6I z?|Z-Z`TM@-m!6q9Wg*CzPI*Z~j7Z%<#bVSG3`0>=Ki>QB9&Rywk_a#G(ZAkl>!;Z9 zACmO%RGglq=t=sUoo*oIga9Ex2oM5<03kpK5CVh%AwUQa0))WrN??5;)_-VZB)0A$ zt!P8Tv5>#VPdqm@adwJ1JMrYHDaQYXd2onn*^uTf7A%87a1Ajf2k#ZzX56y1q?N18 zBCL*XeT$(Xjal%V(x&2vj>iuidSoOApOTFbAOr{jLVyq;1PB2_fDj-A2mwNX5FiBpKLir)5bn&~$z>`vntVU` zC7n+FNdKB#PQ{Zq>CckirE;lv>8I%rQa9_+V!+IYUj)OD7RlU8uf3WoY zLdC5jSRV7&pjm&V8XW~s#Ts?|FWYM@9Rx=LNmj{1Ykn6S)!nLNSO&~Dj^`c#GhtD) zJ8cb~zYFj&UsR}4rQ~Y*qA>&xH|~DTC*5cx$}w{841ke9$m%`dv9NC2s8s{Vm`Joa zr-IxHDi~II;4qNGdp%fQfg8hZM|!E1^?3`IHI5fj;An*Fasb`89KVgy5is7Ah>%s9 z^YYFLESE7SuN-L)|E_<2L0bzLRJ@fy=!X5(k_WC)Lwz!pI(5+OlMgb(H-@haj}HAb z^iKa5eb@W0gSUbY8@~}hP0elkbn2r-flV(eQphbH;|Fw zFHc9keLc9GPZw4+y8^vJKAmUI*G8GNJ`eRpSoW{erzfQo^~*Fa$;>-TFk?HqW@nyx zdM0Dz-+XzV#%e`Fv$YIcFR`s+28YslrzEmU#>0_w%nxJQ9P~1cnCFMn==qrDx?>#6 zv)ot_B8}xa7R{Z*3cSqcB$*d@S>oBOB;`bPlu@!`mJ&)?7iK*GhBH@NJRjb5K%6T`;nWq^e3*(*-f7s9cd(1*jV7o{ZNsS2Gq`99yyA zD$W9nj)Od$R=Hyp%ePc)u;svN3-v51wBBaAxM8hX0e@IUR%Jm^Mj1)YVWUk;YEc&@ zsEUdtm_;)uKtWY~bb|kz9Q;vEc)3R|CZO*GBPKQ$!7W)%b&5km>?{Tsa%6yLJM3v)2O)2ua zF36%FaEhj?lG$N&+^s`s({K-+O`GhEXISW>_q9v>Kw{#G=vzxPF=|eOTSj=Rpd`zN z#L2qB^CC`Dpde$1E*YvWa;7E;Mc7+VA{o`@gmAW&Onid>=l}V>#4AH5!MDSgz> z_k&d%Uj-wzUNVAbSDJBq^Lw_AtU8jZJW&CMYC)XrR>FF}mr&Q|>ajNRA~Se7+#+-< z4{Qh`%;I?gPT&Mn#1W7a4Ougac#3G6f-LRefg^pHS_Vgh+@ZG=Waz`#1D&~_{aE|* zo$FL$`l=K0xovN$^K8rb|EJD&Z?g^TjyFuLm&sSFmub^-5A&@s?6kGfQ{L6v@3se;EsjoTbVw?faB!FVXtgRQGk-AWz4N&UPJT=}aAoQZ_V paItdFj3{+A{^~x!NV<5d2%K00M*;)xC6&gn_E&FJ2ljEhe*^AtyJi3Y literal 0 HcmV?d00001 diff --git a/jupyterlite/files/test.ipynb b/jupyterlite/files/test.ipynb new file mode 100644 index 0000000..a22b22b --- /dev/null +++ b/jupyterlite/files/test.ipynb @@ -0,0 +1 @@ +import numpy as np From 7fd18cef3c621f519fafacb7d2e4ebdfab348a88 Mon Sep 17 00:00:00 2001 From: Laryssa Abdala Date: Thu, 7 Jul 2022 13:12:56 -0400 Subject: [PATCH 5/5] feat(documentation): Add datafiles into jupyterlite files dir and clean up code --- docs/.jupyterlite.doit.db | Bin 20480 -> 24576 bytes docs/requirements.txt | 1 - docs/script_build.sh | 1 - docs/source/App/app.md | 8 -------- docs/source/Contribute/contribute.md | 18 +++++++++++++----- docs/source/conf.py | 7 ++++++- jupyterlite/files/test-data/HeadMRVolume.nrrd | Bin 0 -> 71444 bytes .../files/test-data/HeadMRVolumeLabels.nrrd | Bin 0 -> 250289 bytes jupyterlite/files/{test.ipynb => test.py} | 0 9 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 jupyterlite/files/test-data/HeadMRVolume.nrrd create mode 100644 jupyterlite/files/test-data/HeadMRVolumeLabels.nrrd rename jupyterlite/files/{test.ipynb => test.py} (100%) diff --git a/docs/.jupyterlite.doit.db b/docs/.jupyterlite.doit.db index 895b274ffe3b142a9f094ffc55d6562abab32abb..c4e27a3225d1096e6f544af2dc548739a7103e1b 100644 GIT binary patch delta 2128 zcmcgu>rb0i7=Pb$UP{~b0-Ki0)~>V&40?Ot-pd@2aw`z}*SWIj56AE012jGZVcPtT`Oqio$LPQ_< z@L?358X1lHB8SEjv9ZJ?-Na{o4^6D?F)`Zp+`dDjQwL)~F&rD6w2VzmM9~`#eBfU| z*Fhiau^(yk5nAH2C=Ffa9SD5{GiC!qZ^C)A4xy{CVlJ1Uca1oJ;MIVx23;({JQ^7r zN%$rcVqzrXn;MIYkpt*GCDx+&L~JN?hh7JRrMd{cubSC}%TUI0Y7$+60ZUyyx**3T z>+z#cRCs$9lno4hnEgC7nOJvnNsTMAw;T9R;R{PSLf7Csi@pkdrVbQgBZ_CtHw@lk zvWU#dy2Be#Vcmw%WoWRLA@nx9V5RtFn6?@Vu9sssf(OB;C1}Zj+YrcuT7=$$+t#X` z=(H$7o0Z1 z<2C6G!(Jim^a?ho7>RkD4*KOC=3RWuE86T~F(PgRDnFLXl1(JXzk~Xx1a98pa8UnZ zWH=ldc19w0`*1iK7VR_@mk=F}+G1juw?z!0T$;D&H``u@ui7)l`oAh#ST``fv+zfugg8O56;qoy}6xO-$Ut!d@zE zt?c1&gPUy!;cWL7D!%_oSI_4b^gq!RGTquosw_q*ZSim? z6QnkM#GhcLCkn|9&U@k|ST$>)%YIPOL~3wZ5`GEn!o8##z889NE2)B?0#cXyU}>kPwbq3es4bI)A>(dBqQ&VzZ(T-q;yV%l6!~%eVuzGdkBxc zNf@+hGBR_|A!6eWkh**%c~ajX);z%n%66144?j(4UP-L!p000LmB8D1ubWOU7w_g> zP}*H9OU`?Vg=;$Fhb41)y2AIvBP+X&S~;O;r%A4)4a2H$FzOrh_u#6Uwt)xswYB^S DCf=8@ delta 878 zcmZ`%OHWf#5WaKHxuvh$3kixXf`CzcwUrhHDhR}urqV)d3$$Qc3Yv%yq)>!~)p{`2 zrOmig6HGKF5*JP5!Uw?(|3Rb17^4d}>QW=o+d_5*WtY=2{i>SJO6v?_HY-`0%B&75zF2~5Yo~rGB!JL_5=(W z=(dt*JsmHl=VwyuO?qWoU#f2C1Gr)_5%A+{OWjTg%ARt%olF(!8-xL&q$ncm4I@}@ z-AbSjJFP|nUL3ZXM2IU}qSb7|OuJYQVH0iH7|?MpkvercF<;tDnK#xz-2@kHH7Xcu zqygpWZfJ+&5(^0`@=7pxnM9vbD|w~)^>+x#|3xm@!iWjR^2r!576Mg1Nq`1Z&Cb^EE4_u`<<$@J~wQa<@WR9|i5{jB@?5nMEz3Lky%!O+xvz}{-N z*jt;Lo9s4x(zjPk3j!(6C-tP@J^UD~y8A*UofC8cokqK=oz(8re9&a&<+594LDA2? z$Wh6w|E|BUkJC9l(=F$dZpwIyCkiK>DWEYvg47vPFI?us%#(E&)@*%%4?BABt9J{o zH0w~^A>$)^GfTU81fRuS>V;E0tWb@(-)t;o+HV3b*$C%5 -