From e9f2d7f394dc226fcbd8192de93d732e688655fc Mon Sep 17 00:00:00 2001
From: Callum Rollo <c.rollo@outlook.com>
Date: Tue, 29 Oct 2024 13:36:16 +0100
Subject: [PATCH] Create autobuilding docs (#41)

* docs skeleton with rtd theme

* docs with notebook

* publish docs to gh pages
---
 .github/workflows/docs.yml     |  53 +++++++++++++++++++++++++++++++++
 docs/Makefile                  |  20 +++++++++++++
 docs/source/_static/glider.jpg | Bin 0 -> 6328 bytes
 docs/source/conf.py            |  41 +++++++++++++++++++++++++
 docs/source/glidertest.rst     |   7 +++++
 docs/source/index.rst          |  22 ++++++++++++++
 notebooks/demo.ipynb           |  11 +++++--
 requirements-dev.txt           |   4 +++
 8 files changed, 156 insertions(+), 2 deletions(-)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 docs/Makefile
 create mode 100644 docs/source/_static/glider.jpg
 create mode 100644 docs/source/conf.py
 create mode 100644 docs/source/glidertest.rst
 create mode 100644 docs/source/index.rst

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..ddc54d2
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,53 @@
+name: Documentation
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: checkout
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Setup Micromamba ${{ matrix.python-version }}
+      uses: mamba-org/setup-micromamba@v2
+      with:
+        environment-name: TEST
+        init-shell: bash
+        create-args: >-
+          python=3 pip
+          --file requirements-dev.txt
+          --channel conda-forge
+
+    - name: Install glidertest
+      shell: bash -l {0}
+      run: |
+        python -m pip install -e . --no-deps --force-reinstall
+
+    - name: Build documentation
+      shell: bash -l {0}
+      run: |
+        set -e
+        jupyter nbconvert --to notebook --execute notebooks/demo.ipynb --output=demo-output.ipynb
+        mv notebooks/*output.ipynb docs/source/
+        pushd docs
+        make clean html 
+        popd
+
+    - name: Deploy
+      if: success() && github.event_name == 'release'
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d0c3cbf
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/_static/glider.jpg b/docs/source/_static/glider.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..a69e0e4597ea31b4a950e4e26281ba743726c1d5
GIT binary patch
literal 6328
zcmbVQc{r5a-@lP;WvLnaQXzY?lqF0X(-0a&6k6<(?7OL+q-<jeMR;tDCA%Seh{+zt
z8iO(R#9+)|%)Ha{d#>N|Uhg08`=0xp`#Q_#eDCwQKi~U0=X=w~>9YW@p#jVQU}9nd
zQWzINp93!I2f8`|01PG%umb?V1h_^XVcY>gm{EQwW`Oxmj=y?Z7%i5+>p6doF)aK5
zt^q8}%)c`u9bsfvc2?FSM_4)8*p9Lv<2-hZi<67%IQI$O<J^4QTwJ{TynH7?U@-U?
zkANUQNbm#*4Ek+^iG?xe2rCCGD+lN}*KyGQInloWeC$9D(89uW24Lo6V&P+=e+48M
zlvo*je^dTDF)=gNc$AHugOiH^K=T63Oe`$SM_7KZnt={ui~~pbSWlc*xpMR*`~lk;
zFOcf<glu-ns}-$av%yU%wTIp>I5_zQ1cij9&&tTk$*W(usG+H)eeJrw0rUpU(A?s-
zrPUp4n@0|gPR=f_Za%(#{sDnO!GFArcoq5jO;lpi+vJqgckk13a`W;(q6!L&Dyyo|
zHMO7X>f74Cc64ICb#)I7V@F2E#wRA{@biR)#iiwyRpQq64r!N6+1vlkiwR))2d#fH
z`)|DX7`&K|9AP=a_L~<Ia{!~T@Eu`2t#b6l6*$`iuajp~pR<FmCS+H%a!9I~ZGs<q
z4|4KLsn1Che^dL5+5e8%i~kq1e-ir_uSwt-3ll>;7Crz1e4aV>ByzerqGk5%yKq6b
zBVK+Ud$n}nq+L7*=;*0O7Y?Ac1qhLY;K(#O&{mG614~V{hdVP=<MUMYkt<z^<5}c%
zI`F2<^jb<QDo#EOeT9KdVPMfCn2<+wz(ZbbbH-Ytorw<Av>dvT?tcwXe<E2|xZiP=
zR&{F&L9q&+p>9RfXvobxIuH@?i4F`1wrp&c-R%>~T?2FOZtJ`a)fzLUHbChBf>mO(
z)UVN@l~;m<MMMM-o@P6ZIDJdEH9hX?zQsZCi@?IKTLzSnl3Hr{UnX;D;86w}og6yQ
zl1o(>W#PlcVn$PI3LcQUGm!EU$I+33Ujf9JO+vW9Y9H0Voi=GzxPc0aU4yR|@vQk>
z62I5Nb-{@aq>Q%HjxbouQmhKebu|*v2;zlRPFgi-e-v@208(n9(+_!>8cQy_FY)US
zbLBQ6M6}rzI`G((GM2kR&h`2<?Ur}=q;P4Fdd74f`;HFOaYHg}kaOTvqJ2Ld_$4dR
z-|)<5EUV<4DIF-y{bBJ-!lrm?{!fZ=p3HtvbRlHc4U%tT8d1+lvd$X-)Mv`T*vLoJ
zd%>BceEyW;hh%}AD_jvV`XV0QJQS<wcTUw?tD&UK1L@*$SODVrk3aIGFosxM#;#G{
zo~Q@v8C8=dq6)@&v9mYwbV~y{j)Ppn-YA*<<!RdOnwh{>nqR`KedHwKSzPX}!W-1V
zJ=%kycZr~|{w7SBIj+8(uydw9+bsXib{Co;KVmDVZL#1tg{A}SKN#}0(JZny<GSd8
z?(kMgXqLHwyS?YF)qS+&slf2d-ZG}$$<;!URCFA=$^f>(a4(75c??H+FmOm|v4NB?
z(e}grD$>-TH3g8OAyr7l6J7J|j~Qnjgq&k|I?=exZ|dR%Mk`B8aX!!6_HPwgIH~0t
z2&-uu3FSX2u8DWuW_o4?ej1NB^mVFPDtKCNF=2Y3=V@{18r~{XG}45@(tMxf58Sfr
zOfdg>BDmzzPvb)pwWxnpBMhM(=gL-*XL-Pd2n@HFbAS?Q$$C_9m(B;K!;J?<17zfq
z$+pt>C>Xkqb0WA&eloa@T4aoMrY`2<9`0Hk9Op06u0SajNC7Yz6o`_OxM&e~-p)Xi
zvqeQ~B_^P>X0m&%wWh}l@rI<OM-aP?Si&`%>J1bUHX~%OV9PXIu6WAKbe$`62opC?
zM7YARNre34&KlLBjWZ5thl}DORo|6ZY2|7P$J*Vq(utpxOm<c^jzW#248TnN@=8#P
zx{-64c)W4{6u@IxmbIOR?^0E?kZ&Bgm{tAN2sQDsB}Jj<Q|70&J~c(jNNgp=8-BM1
ztuft1yUV>bcJSgY&;&A9GjLzuv)(Gye;kWAKe#CDDPHZh20gtRVsNQfJ?K?BrbIM&
z@SCy=Cg@ed5_`nEIVi#=mT>2L)kRPM=~HyWOf|3CR@{hTs!E38RNk0IpSKq>btoGr
zFN(BLg*4rj_t(K_D0S6FX+%Xz9$+01!CA6(Z~m<rcWd!1PWCr`1D<fWs%4NDszIEY
zhenr%%h+8JBh>2zOZPxMSgUwJg^)(Xh6CU=oVJU60YU3W#_)?tb|~?umwb>4xTh$<
zwnkOjw?fj!#RX}dln?c3JkxF|Ju0W}vt28vMP-pkyqd)+Veam^u9KaWwHm{2@&gZY
zC&SnCVnsaPtD{cyewcTWTGv&G+lnax`-iVxll$T{;V37S`)gXgCd7T}@FeWov3Z3U
zg3n$s4LlIogXjNaR_UVAv=97M_XV>qq5BR=6XwO?$=iMyj4M@TuGmBEM#_y}?;#;B
z4jLRTJy?A;$8UNuTp?reIO}_%&@qo6=8ajtsq$5}+SQpBj?F%aL0?Kogg)CUnI^Yw
zMwq(FJ(Q=ddpH);0ZANH4!<E1{=HcfJ>r|b*1|ziHfY#>lzH@P?Fr@0Kd8_;8d#Lq
zI84na<igZ|V*k*MY3tY^i3lBwggZ7A&oA{VcSU4JFVr=3LwRXLmNK1$4@q|Kok8)F
z22}$~y#k9#fWsjhxJ$G-Mj_0#BgDvNcXYZm^q1%BGWJ6|NJCy$19w@!{?Kd;ywO5S
z0+%a!Ff!5|T9lkIc#&v8yhT6+$1pVP7VR7p&tiB@I9lNSI+T&+R!<OD_J^hnMxP12
z`f}?=ovvkZW9vzur_Jc3pn|4huvD@rVB%$2So1);h;Pi>sG+4=6W+!>Vt*zVrz^Xy
zTb!-0gw(}06W)vOID}xsozddXXg#xYu!Ic*XcKfX1ilzzws6J!CNfx6cNL;GiBy}6
zvk;K_M$VhkBrjh|^ZTSab5DwYP<<FOtuLBJvS$y~iG*1+U{x;QR4YgpbU>oBMGH^U
z=>B|(b9Me~KAg&Xw~H3tfY{`zoWluVyu`u{`4(Q_Og&Qr2%!T9SE;}#O_Jhc&=P&4
zAyb4S&D!!<P$xf&d@=dWtbbXm4q`sY&uFK5c!&J`lRCxRG-{j<e7Z5ba5y*nO4mf2
zu%vZifAJIhj`)-nrln@7)kscJit;A!YS!e%e1q(hr#KX$3n%zixwUk*`@-c~?NlxL
zs}KcFZyy;OPo9V+FK3WR!{2G|P;Kz;^YSUeCil{3${0JgBwj>8&QIhyCt&3LHS4W%
zamejM^Uj(~kt*825c9xO)iMqJBP2c2vORY*lN%l2ZIsiUz(OjNobR8CZ?i>-Q#$#h
zH^y7+WA9A5PlgTi%q41=5`<fdrM2Vj@K_3G-L4hq0FO=OqOG<lPrC#%Q<~yaSRMUz
zG9^PN)3GDwr$6KXb~w6QR;?#OwfL?lv+{5oS}*P$)90+bzigUqH$P?7#n_=Mt&oq0
zeT`5!pG3)eP9HkJ%v_IrkyVu%U5ymHR^)!NXO5yIc>X}WduWP*=ByA2NB0<ym^GsH
z?DbHIP9W(w5rKu6TKklxF|B{|ih!+LVo#z&$Y8<-d@mCll!^8Jv#y~zVUh16p5bp?
zeGA!6U*I#NmFG5M+dbGgR<1wj4KS%a`?5B`X|CqQ)!^HY(~x~+P*5hm9;6r)_r&C9
zY7i+mh*Z!x;01mEOMdT$G%m~q7v`p{HpOteD6Omi2Dss%vm>-De=jINY~tefn$=D$
z4}8oaK~X7lxw9e5l|_6)#|a%OHXB`b(y$6vKVxdXZ4`HRBJ6PAs&YkJw-o6tR+4u{
zP@n)~@9n-f^HrI@{GRea>O#rwuj_~7!9M~P_9V(T5x_&AIz>AzZC`;IW&Iz$3ymz|
zNECnNOCxS{t#5^${z7k<VWEsXq%l9T$v?Y2M4a@#gz{wg-t#l*zCPD~%+|le-;g-y
z4zWD<ybLF$k>-?tD&4vwtkSRu>=+wob{W9jjJs4=HWxD{^cpWbqNYs}Ez)%i2(d3}
znb=xJ+;JQ~re|-WsiO#bSVIS1_y&x%O&g+A#c|1tEhox;da7Sq7v4JUKSmTp#q5k5
zaJ!p!h|3vsj(>Qg>>we3k_;^gy4^uY_0g%i;gHa8Bu+YHnbUZM_L1N0_hCn0<=(uj
zg&w2IQj5QGYoL+_GjFGMX>SdgO+#s1RQC0`xFPoJ2!7dzwgs=xgMyjNP9_aN;0(3#
zNVO>|a&T-7B*9V3xK<`4@s(sY<}*G?CNr>r`j>oiTk%GX`-6@9SUcy>xxHkNcf`cG
z?KOk#H8?|Y#(a3UfJ16P?9;j6Q|q^@HsB6}Y13DfUi)}YB}Hi#Y#X?arzd(r!Qw7`
zqPdGw_&9l;;bf!p@I=@bvA&yik3_odf|nDwAH^<63l`Uod(D6F`rwQXmUylw3@d!S
zLAsz~vn0nc$2j>i*+}p-3+*xM8d*i3NT^q^Bq%pnp-!=@Ha?2sZXari)iEaiF=6=8
zw0*0wCi(jQE^<w|q3-Z>tGL*Kz9>c$NqMl}vvcjib0z$p9Q`<T!Q1d>Z26iygjqAf
z^Fw#leL5g?qu<nL#lGXoZLgEwNghq%&O3d=@X8o)q6DHq@p8`AG*_@yMqs;@DbL!)
zF``EZsy5J0;+A2u%<?q}3STi!iFi-@h@K6f(i%?!$3gSDopC_G1ycKfPOM@nOc6&1
zx?74u<u}`Ee9W{yJ`xbsp3oIDRhC}DQr(fCw_ZVE3lqL&uS1%!h*{e8+SJNb4P~8Q
z48^UHd-!as+qv;|1NVc@IPnzm4=zJdF%Lf_PAE%K_Dftx(+lA^<LTOwzu&cIw{tJ7
zL)0QDSKT{OMF!*rUyK>-7XA7G-T`Ht9A$lu<8<{!Fa-q_zhp6=OXIGo+RkI)jlogT
z;`kWGHwvT%l0cr~IoShE+Ul<Pcjj&Trv<3{mOcw80j=)Q)m?esWb1+syF-4$w=&5h
zgZ$|@W~LNKatKfROr%l1yqj>&(I!dXr{}-D4z6vfHN=ODAlcpb^U^$!F-ioYW4UYi
zzyo=$m&Zs``Su0<Y~Yn$npD%~&WbzU^3Caln)YIYi&vM1ZZ7qB`XtzQWGYaiV>${6
zK?+{c6kL(F(Vp)pBzgx@pvm=IZthIg%^{s3#Iay#A35BXyQB^j*7`@>r8JiWe>N!(
zNu7|L3&|k`K?IDDX1}*K!`#~ylf1phzYx$iot{dGu!1LNHIXcZr4k)D_2_n@I^X%U
zJq*X>>D3XdPP<FSV&X&JK8^LB@720P2lhz|NrvPTjfr)MP%WoNiSGLwZFGRc&B^<f
z`-e8HMvPrtxMwv&ZL{<e@kHirj)kC`NySx(Bg)c;_>lCjb4x)VlX@9~z9SXXBH{2y
zQ*fl0{j^2-X0C~PVdvmo=}Jh#s%3_CeX<yV?CJd<s*J_={w+%m=5ww%KJK#gzpI!V
z&k=xx8xU9J6+@y_e#sJ;|6{fmfF$M;a~5$%)`VA=Ew5j?q1&{oIJ$Pb_q7MAy9*%<
z5sp?b5E_>!RA{mY^>Gg()!)r;bm=S9j#nISn1YGIC1L83ZaFbk8tCAr$X4HmO}pYp
zA%4;yQAIW|&)s+7q*7W$7^cKERGAW<CRV$fyf{%t5W3CwG$M>?rM`(>&FA@O%L}R{
z(VZ`<Lnr-o!MsU2d8t-CWd-3Et`|vi1~!kKf7?>+qiL7dEZ9=n(wE710HJjYLtB;H
z=I?q~+Im_iUW}7VJAI;EsPk#|JHl*0+5OR_K|lSZYuIxhw!d-~yB6UJ%0;E#3U;uU
zDvMToP)(i1X6cb|b_$NXn^8x6Rp_;g;BF09wlWVIV`hDvcO}3%t0A`e(482XlPMGD
zBTV@;EYf4c`$SuzuOt`zu{mu|qI#6jQ<!fkzF{?ZZoO({gWHX)?CF;~UFW*fc4pgz
zEuDik*MH~R&W_uHjw6vB+Kjn*e;@|-RGWt!=AK3jh;BinVIRwtJx_iuzcD-84N6qo
znVQM)rlAkvU-Wo}P?}5DBwb&(q~(L2?V9NWiGfg8y!+D>>%{)Sy932r$kg|0D*jGR
zQWafNB)#gaSp76L`%$ltId30+N}x_I{#f)hv+qQ9=JW{_Eu1B^#7g`|=tuS%Q3fek
z>s<9aT5tZLuTwOeit;>k9`2MO>V0#L&zhhMKI#KoF6~Tz@(sZlFwPY6_<&JW_g1!W
zJariK(dlK9)m6__Sg~3)(Ld_RdLKdIV4Svv#M|5815SPq7f)XH7e70U7L`d~s9O_l
z3~y3+OS~B8+fb%`-k9;L!naIQFL~hAhnzZj$uSH(LVvvgz5M9cMm&i5PUiTk`!||g
zsPSlZUetUW+3W7L$3GV89Bq5Uz;}3|b7{*|kNMZ?-^%V=!<GJw&1v{R2ZEmc5Du>G
z6>8GErS(M5iD(t&M3kNo#kiqVFqw#%{jqP0cYb<2ZqvLc)|57Cx&!%>BJxu8gC0zA
zN$Vr-j3-&8soDtdUerV$9N&+gg|6F%6uZT{)ME$7S1WmyN-g+2pU!{sHZbkRU>`Pr
z+Z>1zu=#$!`EAa<cr%xiH0y7wLP2EAl6`DIea_04$F1q7Wc!&DhA)uGtvt~hNrB8`
zX3ez;8=mW@&x!dXwE}YM#4gJx)MCeG?W8DP;*zLiCUE_*2VG}VQceA5QVHSFFY%)1
zOodEUvXmgY;e;?YyeIgs%kG9($l2DxGi-~V_aSA5M8wI!X7bl6jkHb${r(@05M{mT
zHD&V=)aW_f;xEfY^Dk_Fia+xQn?5c3uA{q&Ql8^95{Nb|m1(MuS_kiMEF*M@sMqhB
zC6n47q@!NZZa21c(5`jKlzo)#`nUn|1Rso`>nL;p0-sQK7!F{Bo{Hxl{Ie?BUg`1|
z40J~;(qS;km=S%-miusb<(^G%gg3(P*Qq~+NttQOImR#(5-=A6u8jP+J~G?Hr<ikb
zfyc`_`^zyFUXd3}YgT?@C+GmIwkB<B$lV2HJE#*~eZCd)E$U6)x{0SxPO1jRL}Ouk
zM}G!PiKir)-L2yMQGj$|OLP}uJjr<|7XR9ufRsO5;%piE)5$<3PFH~ilc{UZ<>C$^
zuRR{S`7m~2??t?7UtFUyP51d-zgb3{5_$nIhWJ{e{2+hYep0#y>+UxbsW@?bxU6T7
zb3mZCuqWAV0P#xp*4M?Ss5fZ@yKPhB`p|v>TWlFMOsCv6p=!c9MdgRU;o24~`5;9q
zG3=6+h-aR=@Mx)eteQzC{*Y#y&aUvwXP9_lO`M6sf|v6XR3=5Y{M5vs?r5qzt|cBb
zEih9WGB!rz9@;Ve=~*?ovU%NqJ=vey8wS%!+jG-oGZb*2o+d-Q`T{Y>dspTrGp>JP
z9BWhFNT`LLKg>|41KicYsjs8lCjTVp$F%b8oH|^jc7zzR#sEbire^|-bBuogj=k2W
ze)Jm4BSFMFCQ_;YL3_Y1)B9}IPRK%DC@sT%WfRxNw}7gnSbEs2V6c7_Pu6noN<t)u
zl8~mO@4U;ZV<fJ%<}@UlT7-@@33TsBU{GsNMqH{IRSeK{AvT&jhpuno_y5(c$U@mU
zbeSI}eT3^jL;NFxt?rgB=V5f^GHkxr=V!ioU`c-6=v5q8)NWFRE#(hXOzL^b$|A~?
zGXI@($<?Pnm>B0S2Y;FNHhFS<5{zOu{NU(7wmpP;t?Umn7H~5MT@i1dPSG8N(ShcI
zoVU#&E$W$aF7>FRU{k<X!VtTeR6ZJi^c0A|q7Tjp%M*l<qnvXzdd{)2e80ufF1o#@
z58ig4cU~@@gKErQ3QQdH?u?qjaWa*jiBed0kzjj6X^WCAtx9+Tg6jkSLpc%wf?t8s
GC;kgC@?`A*

literal 0
HcmV?d00001

diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..f771370
--- /dev/null
+++ b/docs/source/conf.py
@@ -0,0 +1,41 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import datetime
+
+year = datetime.datetime.now(tz=datetime.timezone.utc).date().year
+
+# General information about the project.
+project = 'glidertest'
+author = 'Callum Rollo'
+copyright = f"{year}, {author}"
+release = 'v0.0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "nbsphinx",
+]
+
+
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+
+source_suffix = [".rst", ".md"]
diff --git a/docs/source/glidertest.rst b/docs/source/glidertest.rst
new file mode 100644
index 0000000..2504071
--- /dev/null
+++ b/docs/source/glidertest.rst
@@ -0,0 +1,7 @@
+:mod:`glidertest API`
+-----------------------
+
+.. automodule:: glidertest.tools
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..6e705be
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. glidertest documentation master file, created by
+   sphinx-quickstart on Tue Oct 29 11:30:19 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to glidertest's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 3
+   :caption: Contents:
+
+   demo-output.ipynb
+   glidertest
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/notebooks/demo.ipynb b/notebooks/demo.ipynb
index d6082b2..1cf834b 100644
--- a/notebooks/demo.ipynb
+++ b/notebooks/demo.ipynb
@@ -1,11 +1,18 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "id": "c6a29764-f39c-431c-8e77-fbc6bfe20f01",
+   "metadata": {},
+   "source": [
+    "# Glidertest demo "
+   ]
+  },
   {
    "cell_type": "markdown",
    "id": "97e9729d-4db2-419c-bbc2-a2078fc9b7dc",
    "metadata": {},
    "source": [
-    "## Glidertest demo \n",
     "\n",
     "The purpose of this notebook is to demostrate the functionality of glidertests functions. \n",
     "This notebooks can be used to diagnose issues within your glider data. We have added suggested processing in some cases."
@@ -347,7 +354,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
diff --git a/requirements-dev.txt b/requirements-dev.txt
index 905696d..78e2856 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -12,3 +12,7 @@ skyfield
 tqdm
 jupyterlab
 pytest
+nbsphinx
+nbconvert
+sphinx
+sphinx-rtd-theme