From 86639b94379598cd67ca6c83340df00be1922f78 Mon Sep 17 00:00:00 2001
From: Bobby Noelte <b0661n0e17e@gmail.com>
Date: Thu, 10 Oct 2024 08:33:21 +0200
Subject: [PATCH] Add documentation infrastructure

Add documentation infrastructure and some sample content.

Documentation is generated by sphinx using extensions to support
Markdown an restructuredText for simple documentation writing.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
---
 .gitignore                       |   2 -
 Makefile                         |   8 +--
 docs/_static/logo.png            | Bin 0 -> 12120 bytes
 docs/akkudoktoreos/about.rst     |  14 ++++++
 docs/conf.py                     |  48 ++++++++++++++++++
 docs/develop/CONTRIBUTING.md     |  48 ++++++++++++++++++
 docs/develop/getting_started.rst |  84 +++++++++++++++++++++++++++++++
 docs/index.rst                   |  17 +++++++
 docs/welcome.rst                 |  19 +++++++
 requirements-dev.txt             |   3 ++
 10 files changed, 237 insertions(+), 6 deletions(-)
 create mode 100644 docs/_static/logo.png
 create mode 100644 docs/akkudoktoreos/about.rst
 create mode 100644 docs/conf.py
 create mode 100644 docs/develop/CONTRIBUTING.md
 create mode 100644 docs/develop/getting_started.rst
 create mode 100644 docs/index.rst
 create mode 100644 docs/welcome.rst

diff --git a/.gitignore b/.gitignore
index fe93337..6d705e5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,3 @@
-docs/
-
 # Default ignore folders and files for VS Code, Python
 
 .vscode/*
diff --git a/Makefile b/Makefile
index 82df14b..f3d04c8 100644
--- a/Makefile
+++ b/Makefile
@@ -12,7 +12,7 @@ help:
 	@echo "  pip-dev    - Install dependencies from requirements-dev.txt."
 	@echo "  install    - Install EOS in editable form (development mode) into virtual environment."
 	@echo "  docker-run - Run entire setup on docker
-	@echo "  docs       - Generate HTML documentation using pdoc."
+	@echo "  docs       - Generate HTML documentation (in build/docs/html/)."
 	@echo "  run        - Run flask_server in the virtual environment (needs install before)."
 	@echo "  dist       - Create distribution (in dist/)."
 	@echo "  clean      - Remove generated documentation, distribution and virtual environment."
@@ -46,13 +46,13 @@ dist: pip
 	@echo "Distribution created (see dist/)."
 
 # Target to generate HTML documentation
-docs: pip
-	pdoc --html --force modules -o docs
+docs: pip-dev
+	.venv/bin/sphinx-build -M html docs build/docs
+	@echo "Documentation generated to build/docs/html/."
 
 # Clean target to remove generated documentation, distribution and virtual environment
 clean:
 	@echo "Cleaning virtual env, distribution and documentation directories"
-	rm -rf docs
 	rm -rf dist
 	rm -rf .venv
 
diff --git a/docs/_static/logo.png b/docs/_static/logo.png
new file mode 100644
index 0000000000000000000000000000000000000000..fdd4eb5dd658ea057af890900547b29980213633
GIT binary patch
literal 12120
zcmXYX1z1$i_dYDOOP4h30!s)>Be_UOEhQyV(kV#S(y?@RH>jj^gLFx&gwm{l0!zt<
z6n^;q|L1vb%yZ|SnS0KeJLkOb#As<MlMpfxVqsyCAXF4|u&}U`AMP!I_z&lx)QC3^
z7i<q5WqGW+X{KKf6<j+x4LK~Vh9sg}3%rLq$W_JA0}G3E@ZW(w>hi%F3ybd%p&+N{
zYkF7!3b1(@I69+Y8%a-xPd*jmw53D!s?(uVvvy0L!l8B}tUYeSRGX^$+d>6LZ0(Jy
z$p?cKxytBL^S*emYWX}p+!XATx9K*nnb5XRM}ZQqJJVekt3HbtLc14Nw{~m(<DdO6
zRy^)L-Fx403UmoZz8`77%NRl3;BvIT2eT0%7St9H`YNqz&Y32h9s2GS=vS#zC4y%j
z+rrl~gM))s7lY1<5Vj*~3zV&kbU;1YB2{o42bw$rPK9k_TgY<fL1nT`YO?s|jrj|h
zi#lG<NW<Z9Zz7mKfIf%e+f#gBs^no|_N0sz4I!>4L}#hhP_wN3Cy`f`@HClY95OPp
zq@S@iY7o?WPq&M?!ClqF4Dv#TWId8Gv|Z|#!Px+BXUm<Dy_f$Q+C<tYLk82z!sW=}
zT4ZLd$VhA6k7Bq3CXbT?Y`p_^+U9t`59KrN=SbO1c%sbw;HRwH1eA#~e@H$k=0caf
z=oCr$ufs4KIS8As6<S0yvs=DV=Hod8l1c>q_$B=D&2Qd^20_YZRAXc4CBoPJX1_PP
z*ip6Dn|?u@NL{+fqU^k-_LlS1sHiCA`w|zBwY9sa3>B`+*Fjpf|6)xK9>Y|oiE%t8
zR`vs&hXx1BWahGPS!cF^fgY(}4u0<ab(|HWHf-*7_;3$2jo|p|D3fRASa|<AYw|YT
z?CkjXc#reXqtJNu1kyd8`&#f_HEJqYI?8o6o7pj8xi#3l6+@fN?9V9tNiy1$><O!>
zh^=dsAWs|0Hfdcg$gXa=VLIRUOCUjS!`n;NBHEJ&d5nKZLWy4_))E5FeEcrSQVR(U
zd22*>$b5(<Gs6KMH`jemX0+Lgxy9D9_2!eYGN`=W3*y4ZV1dAe`OjXP5ve4#Q9f9d
zO=p&QXom3%C?mT=9@`N+Qg?ro+4WwZv-|aF+`{uF)l-`B!nvl`{p%IEhr#RtVxn&P
zioH(af#E~b5}oA99yfu1YJ@S|655udo9^Sm&0q{5Xjgo^CkssV`?h@u!#;qE%&^w@
zQ}Y!6DDBw)@R*ho!yg=Xa#e*6hHkK=+O>d{E?<my)JAoMTr~ZMp^$bA1YcY)>>1h}
zuwB_9bP&?(37?+wTxFuO)IQqatsl997AMv|W~5fLuV>Bj%5xaAMzX)iSemgaEL!(#
zC%Ww7Pd%W0kYa}++Yc+E&}oy|r&&+W|MKvx{fI49S>-^wxL{r}RU&3`UIG4EzMKOT
zPhvH^etlH2o73NS0atoAV$iKF%U#>9oq*$FnFo*0J7Uf@CL@Ul7XP$B6R2((2#aV`
z=)b-!M<rwy^zEo{&=R5Hh^}F2?i>f{Nxbw`&wUF8Ci2DJxh7Ao^kWGS>iMU}#{MwH
zlI3YU*utn<FSGPMG0h!2<xNofAF~!PCQK$J;FbI?u4^mqPg~ljwjc>%V+Y?Jv=&I=
zF~N{m18Uy8?<ribQNqu5vWdOOSvvmM7G$+Vx(CAW9uWi-J%<{O-e7@-yt4KTCAB8Z
zl4ZXeo`##qtmn-KN;%WS6QTOL73Eq7b)jZ&9^T~}-!~%j!A1u~4y}FmQMoLvAy8qq
znZ6juA?E6}W1=QFX<}n{3n#<@4EzktI+bS(PzU_-0z^_=WbcRi3RCzBX1u~dBa0QD
zu^@BG-A+TG&QumAf#{H{b1H(Vog0z|$0kZ6Fz*juGWo=Egj++&RVR}cpg4d(WtuBy
z5D>sgExBN~+*j2?h~s*g{Cc^VmN9mKTaLlEF}te~m=!W0qi8vbGyi<t;B+j!GhX9A
z7iqIFTCA&g*z#Rkr%Z@^IF{A53TQ23A8!X6eIXiCK;--Rp7qy=?r)kGsR7FF&E*AR
z(~hGmbk&@v^4J^aKN|c(p<fKnMM9(D{}F{n!wWea{&dNc8)LxP8cB~uUdg<fUGYAa
z-4S?6+gA`2rBZ(T$%M4N5x6ek;7=kleA@_(%lJXUMU{jDcw$_V`lIYc9-bnr=*m}K
zFtp#eZJpvH!6|<j_ahsrl^0=lIi4~g!-6LbECnL6sz)is$!8&M0SQBtLM+|E>3YlW
zfbO^PxPy&Ukx<{XU<PR({OHS`R46}^^AGG{S|`*}A@l2^+Ouu=7wYOYL@`g37zFab
z!uG99TCr^@_|)T8Mr4k7`oDSD4OsN+-@Jp?{fvD%TIaX*-2w7$|E^Y3zD5#+5`xs0
zW#TG^WK7t#pO~pwcc0f&yT1Q{WW30-He537S6T{AHQ4{}9*V3r?)HS!`v(I-a|NN~
ziXS(GKrHnBM=TBu1@rM=du%&x%i6bPAG;<*Db5(lRz6RiBr>AwF>{X_0&GVi^Vnew
z1lIqZE(`)uZl9L?d<p2*cM%6nE%KLRJsjM8+n>T^X=r?L=-xO#i*Q|e59Ne`P@5Pw
zt7nu!+dU6%KJ?e*8aGwhW0Y`)<1>Scz96SuApyGI{BKKn!%_PO<Ay729NV+85W_uB
z<B4H0=xBDyFZgDh^Tv*>))4Hsw*(!Gkw&b+iD&>HQ=YUd3klvjK$6ddny|3sQ@je}
zQcGt8y;j?Ywl%1Nupi+O#+J7+4gli6Z9@^``m_b^kVzMn>z28uOjZT#RDx(WHBu<}
z{jN)y$d>h2Yf@bHiS^hSm%5}Q!kq73Gw{AL_XIll`D0ZlokBsjAr1Mw(U1!&Z<{sC
z5}c8cE6nr{O$qXm6Guw_8HjZ}p?jEN$YPkB`NybyJP%G1y5v19#ux}9sg$$Z`iSj}
z8PKQJga?l2JgTT4VlBi$rbBy2uADu2-barzC<Txz(o9w;{K+Q}5_;OIgm%jXiz<V!
zzy2U2p3G1t$z=qaNFlMPuPADxq(dL8)nA&h|G`BFU+ikuo2yvgLHrf~<!8qWg9EbK
zLl5gak^>o%5va3oflE#BO$Qkg7F0bHWH&~pCZq{QYK`{1GuSRjEmD{<64wHRw)Z)@
z@pRJhXTh-+iO0#`G;S~mMc6VW=iAj82N=k=9dgU1L^6)t6%VnKg;3x~1VJBq!_Q#E
zpCY{Di}4`LfYDVaA~OnE$x{e2ISZB3EUJxNZnrnyRfDDMTMvI^2ca5QC_kHGWv1;5
zS^c~ixb5fZm-m#TccQn?y07PABO3^`o%=pggrYe9aOztaKufvX`kN5%`MCclX3h|?
zh{k5~#Ni{mZUX?oZF~?f!>Mj};?laHZG{#t?q76*VrdrwN|2oF4>G>J$mx!}K;ID`
z!T1f7F$RK|L*frov%<Knrv|n6=DH>=??f(U+K%29`VNK@1don<iab&ASdH|~pw-wE
zjgjhTH%kz7A{K-Fb<rMq#<CE(Z{w6wzdjTO2X@4<_Gt}#Z|<9iu4E9PgMr%y<nMi+
z3oBB*GFQy7|GrWp@<TD;UM1jl`QdoU*KZ^zf-X(JdqALFAhz0=nBq)T#8WP;qP+id
zZsXS*qLW^VIi^djePcKRJw#gZW8ntO`aV>up#7gBwK2+OcV8bl&AM6r)!1}R7+TE&
z`+G(S?T~{rjW^HCDAOD9kic|rQ*viknEfKerUaFD+Q%{d_6d)hpF5~dh>KC9<_naX
zy~(>THQ4LH2~J<@1)eij(d9|aiiau`DwAg<JXHjHHx$67dMQMs;2%WZFc?reXT&J?
zK$5mbN)YOu<D>0S^Ca23&^NVSaoFKrc|JuWY3xuv-eYui;ul)Qir896dz+q|#S#GK
z5zCZ1VBN*b!2aL?g65X7&0p=q;2-RfN_4rpcB6JREs_2!0a(>uF4sA-5Q~}v=r6of
z&G5W?h=Kqw%iNyPIn?8<h6SFL)e2TBW|BC1MxrYH`bDI;bcTWr&z|Y2cojY#+>3Mi
zhBAR-Y|L5#d~o3O#!mQ#G?CIRUs$Z+%cf>R0)i2JSp9{_T!u*6yT-Mf-?FGlq8ZjM
zXr=Wh{}C~8v8zw*ZwgwB^2bM_dYR%Me<8k4^%9p2o~~y!e(R3$@UvPK^IKp|Kp^0p
zdiZ|JR$Npl><$@yGV%;_bsvJ_wAUZ=By#-L8MQM9b<3D=6<a_g-+#CMM^8RLp&SQa
zahD@Xb#~UNLj0l3@gl<T<h9joEVKOAA*CG`B3OE`Jp3{1ZidKPqKnt&!<C&`%werH
zHZocL2wz0dQw?F*jP!V&4(p2X09KfFFPNU&+ds4CS;kUWuYR9zD<`(C-lW9XibEGr
zY0>rl(buuBOR;^p2Q(Z<TA7sNgk#&VzaBMXgS8*r`gge6-jpFOsffPxZ<+UZwH(o5
zArj6S!!%xUc@tgp8n!1H%AguLv1#hMFus$dJ8;JoG_rdu{$#H`e2I<Xq=D^guFrEP
zen|DMO20~Xo@m8Q<%bN}NY2rE)rM>px=x~I(!TQhy3K(9RxXL9e1EVJyWLms{r=9|
zexk_xi$l(VomoB&YFd?pPt9(Mjj%&4oE!+fdlN%qjWH>;eRg$c`(XKca5bJ(<7=F7
z+c?EVimveOmV0Es_|rMU_r}&QoqDhc117jgj_@`Pzk8vy-YSvi+LqVtDrR?VM=pE^
zDxd|)apz8&hG_RSiyH^e*(~S^;ZlOn;ZpQ+*5_?RZ@-azr%fiG!bN)b&`_FZ!MbYF
z%JWti2-L<5-R`0uc^B#0{=$IT_2tzPStmdr>0Ygc5i)s;7|$Aon`+WPhtB>CyBlYu
z4fcDC5mmLpDh-p~9n89ZjLfeBT=5ZoZ*51M2jMfe95QU(KKhT@0%ehIn0y1_AN5mJ
z<i#C8gt3wt<XfjRT2<pDk5-m|UgYF0MGL8nYI$-)oK~76phS?BCzJRHm4%1M9{l0{
zF;qg;y%ANF*GBdt!Lss#kWR)Ofta7VEbTrP5`dF~M|b%M)9*}dc4h3hw?uOX`&^CR
zqsPO|hh~omg&H@I-E<J5<C^7Aj2{B^&BU>hIK2n#my?|RoEljyh2_EP5qAbAkQ{ie
zd^it07!S9XEOiIaC&IQv8pS)Ub_^kkAvzDqQEqTH<NA_@X?T#ruR>KtV7U=N>ptd=
zuiN@km+0b=1l;hH8+6zcgSZm`0&4Kn>856udelefqj2ZCe2nV_CV-rC)br=buZNu|
zX2LzY9-|ty?jnE8WsonF8IyGZ2(;#o6GyW3$I~vQd(UUf)C3~)3kEDq(w&X<<R*Fu
zbKl!mVb$i#4uSRZ1N7!GeOcV06~3|W2D^4RY-`w4NaR$`<+_|d{FK%8Bu{OZ5OMrS
zGS&OZK;*fMp$Nh2c5~9dJ7FEWi#t=&y}hn_<VsZ8T4Z*8O)epC*i=O;3H#I7)GcaD
z&1Mp3V2cTwD{3PE8|R4ROh;;gEC=b7_c{4Q)Deyj^J=ka07E@s65?x@2O(g*GxM1H
z*GE)oDWfy|&)2D3Ym<XSkIvgpFb|C<Kj)Xv|JhFfJoe8hdmooD6UkRJYajX47ezP@
zg=_{B&-qqU$8-5Ld*#QisxQ>BROdvTyQIPew^;l9#h(xll1+K5fj69KBXXZ{9R~3B
zKRw6)Q_15@HuZaoHAW-O_EU#q(_K{D&c+d6_TVRu)XRx(iQ5A_k7(d_UmWe!os6-_
zejRYC@Ds_@gmLM`b8>?L!_^(0tUI$r2$)1L*{M}t0yb_*c}nBU(hQwpydNzXjdSbo
zV1fxv_)vg7-gWF>rxA=B{YD%tW5jp6nk41`WaW8E$*2XVBUmh@Nm3-PLw9!vuyJ}Y
zh~SE^%P@T>%o!XathUwj?wSNmVkk5D^zQxkz+*M>_L&58*IG2Ut~UKc>}{}7l<{@-
zRqXE~Ds{RbTW3qFARf+Wn$92G9m0Pce0n_Rn7r#$9>O<|nI@V^i`{7Gw3!IOBrLaU
z&(7cMiB888>W)3O;?~oH`k(5Mkd($ND%{Tn?yp5*os7F5rY*zGz{Q@3?9PyQNL+jS
zSQ-H~lqcrt4@24LEE5$|S9~H<P(4^<dHl~$QXj>6*{{-M;nJecXP<*mU6JIaGzumk
z64{~7p`*jd+sY3pSp~3xbuz&>VXv@L4WqPtX=4<;Z&u{!y&|g14aVF!=PUsg2><br
zC-;6X&J-$CiGik|@B&BNIg_FF!Yd?VLho5p;2X(ha7A!{?OLzFuF8bUI~>xttllo6
z8HV~u*X5>mGdP30nrLi);LgyX>L1&|K1kU;ZMmf!7ti^#jA!JmWE`-!<)0<fSa^UQ
zaIXhIWW~TS^_DJ|gL(wzrgp8<5Lg6}6fUrGbsT!^nb*Ktg-bPFp#JTPrT36=@$TCu
z@Jz5)vn(lL$*YXOcrE+Q*2lj%$hN{<Y3w?T>w|#2XzbW&jdxax9PD4VFFvNpC*5~X
z+&sRAy{ZglUGMpEB+be4%Dg|YPBLe0>indMb#WKKmVSssW8a`h)~W}fK-TA_h&!!*
zBYgE{=}sTLsjrb9UgGek0+i-i6VtlX%O|iX%X-eNqPSG|dn#$4z0OPXR=T%7FRX=}
zcZ=m6>>*mm+;3cqe;g$AfZVMd#+}O|3NvY8zKI6Bsp>v*LIoP;G`=E-ga%tLBMEr_
zu9L3#h$W5tw5*Hq&r>s(DA1ljU2eNP-dIp-g<-lY(m&-P)uN-|b&AZ7oG~26J96-v
z-(g%y)%Kms#f${oTWeW~9s(z{3i#ovljAOb`KZX%xPxx3zili{zn|2cv?hD%6<6YL
zC(7F-!2_jg9jEHpnZr3%$u#{yvxwqoZaCuZ!yTsb@Ciu6!aM>z!8y2hrRClYE_O1|
zI>c4u?R^Y&!9>Ig`P}I+k-sW63~lrxOI1~Ux82flab%CsdBHb*?0qqEt0T{D^r%lO
zw3t`LejBgdm53ATn>J>p*?i3%ztd4`=%W-7P`FbYNICh^83CdG#X4TxC$({H0*Fb{
zs8F%Z7Em}ZV6mig=t+*>tQ3UtbMP+TN{0FzTO+|t^Jct}?|zM_#>HJO55<Hih%!qU
z5X9WRaqc#s=A<{+(Q}@~^o8LW>^w|4tkcIL$YzMsoP+x6EWYCt7cfeTj=kr<vsj}J
zUy+64dh}y5MRVeg{YXpN)Z>%VtSH2iBbwVHF~)1q#|9g~=5XjoP2Dt<!MfYnZVD=7
z8<lUr@o9JVzGzaO2t$7MIik_C>Wo5AI6N`pE5z><ZwG@>=Y%o-WF3z^Exo1a%)hpe
zV!ukX27mx2GO1i<;6ersxZNw<rXmcr*B4ly<cWvjYB1ZWdDyoH$NGIBVO@k5v-^bt
ztx&frV9))GwJjc3k_hvYlJuf+AW`poXZ@GemSgdPDUF5J!6LPlPu~zL`h*&g!h2US
zA`a}2{pYu*J91d6Wi_dDFfhqPIx9sM6w!IM_62$yU&VxJVO%TKiU@qID7zGKYVUuv
z&RHVD@cGB8I^r@q$nM0Io<$P47<TiYD(H0@0{7F)Q)Uoqj{(m&9#fgR8uCU$Eq7&`
zJMCAEgu4@sJ=sXyGpFXT(lUZ1!z{iAU2motf=-W4&vKH!WE6D8)jX_8fx0U>+H|lr
zGG{f<lz?ud%*N~9Y~LY)E_aR3LWr4V6GqjmW(oI|)lHNJ%Xt~!YGLI(cYI=AN+H=d
z-*CzbdgO(HTAwslHl*QA1h_q*cjG_iyNQR+9;4H>lnP`&6SbMqZyJ++p1@H}*&g?7
ztF#g`Z<PaNGL2z3|G*`XOZN1U!v?TWB^pDV_IJqIce#E~Dzbw%gt-`7F2I8k2}#ZG
z+cvtk5puA@K0|p0Jd-6W`(?!RQim<$FyX_GO^ZLW%2DLxqI%+79^*?}XEDYw#AVe4
zTb-;F@myrb=jDC7wJEVE%f;+~D?ioLgH8N3ONrwMnzA`AI2M7{SuK#M{Cn?+1S1ZY
z_WNi5yiFy`69|ZQrYMn0=e<#?52)YbV_dPV6W<Gqa6Npddc;EY?l&Qf$a3yQYWoy!
z7S3_d$}K@`j5Jn3h>$yPAhp#R9O#<%i;Liz|7VLk$fo^gKWb=;*(OJd4yR^YlY=y7
zKaJfhpJ>|0f>s>gX#RrLP(2O`JJBQ}9w^%@QAyJye7a&SX=P|5#Jr6Qn6ZRzcL>rr
zpD6IE<mJ0%T?FOMn>_&G%-|fRRUTmJF}~QaO+R-(G-u({Xbk+fPIf`VT`68uke|Nw
zDQJ8=m5rSYe1%Sox}Bpx%c|+=)H%h1(#NSY^_u6JdkN+Innu9khxRkxM>E_SfX{q|
z_tD1g2-h=6O++`6Tvjs--GevoxOIq}<;z*)b0z~7a!F_o*gZG@FGv8NoFJHhj07+D
z!nEU}v*6fp=$QURI*awUapMq(pn1bs!@}wt_#N1kU{iEpAA|f4N%7)cTJYF>Y0Um-
zoB{0`33+`z!%pi7D@n;O?kI^@j;AZE+E+>H2^J(R9{z4W$p@HU4r6U^;FHHmo1(S<
z)I?3Nq_Q{rbVkxT_PhzJc=ZM6DW9|daSenxOP_Tt%({OA361=fDLXw$g5yPG<hL}$
zRmk7Lk>}IT2vJTh|9S#hVPb;PezZp5yrx=dC7Eogsr_>znV7P4GkN3t2@j70lXHKY
zpKn1)_uPl+1bS?by`PYrM8cyDQVf$CSB(;Z;1dnFr(bb|y4k^gwJD*nd5UI~kUw9B
zg`h?Kje(CiLSx0?#_=WaqTy_Ed6ero(Q(0vxMW6)d+p>?qEo2I2X%noOk~|<;of*N
zWpGuCiFBVNyXqY8SQN!CNbu0EkmkyaW}%SBkJU8g_a{*1Sc+kvmW!B%?e04TtEyUe
zDx^S)3hO*)g@b^>ZjL~}e+NS&g`7#7<8yz*A$>Z7e`|8#SpF1XDBxH5#y{#rRneb}
zH9q^pc=<a#bm*{WfK0NoUJ4B^lz*R<%(Yf&Tr~I}Pw;`{EeJ|nDmsg-Moa+EZmo9`
zatmGooNs32(EUn6szl4lFKLk>W>cBpI)@*4oHC+jc5(+9QK}Baa3@7d6uQIX?{hG!
z_V*ZasK3tqAHDKDB^{TuAvg25iZYqtZ*w8<Ot{}|p;CAufqBjEb)xOf%}o|41<+si
zw|*p6gi6E&kpdVa@l`q|rBeIHU8pW?9vy#`i}#`^=7EGEv7!Z}C?>E@8vC2#X2MOm
zPNRK(97x#bFT@E$$Vjst!r*=S3AtT{lm7-Mdhk0GHRtHOJ0*#Q4B#W4ic<g^dSi*j
zZtCxD&LEbCzEUHxem9>nckMrnLYuscT!l^{FXlItd>@%FA~r``I4WmJEE%~Y{pY>9
zN$t(gi(p@0Uy-oaK!u4E<^rz*D^jEieUvY_=LI+|Ww-yNQt|uC^cal?mJ899{7>!N
z!*wh$szdB?k4B@mdW-6;$wZd}f|+fB2A)-&QKOGv0Y*S_ZnfWkUn<d>{?nF;y)q>I
zxRW=ZM^4<l*Y$^7|L5Jpwk_`mFo@#}$jowTt}afM*DK_OeR>&!@*uD`qIby#Vt+x;
z{`+8xW;XKNxR+J4E*-DPP5+C3ME3npdq2@11g+Zi(?u8GA~f!J&*XX19=$vTa@Hh~
zFW;-M6)54VIk^9ThqS5&eR!4l&7+O#L%x{Vz=KZan7&h}bSL;%w*M>)?eKOIFfe$;
ze0M4f(wBZ)Euj|~p36rO9H^{t>PZ1&mSYSb3$M#dCRlIclLa%Co)J=vGVf~g7hGxP
zIjXS|SuTISx%YoipuvFx<N>QNxXWPX?X3Tv&6q?d5I63>a`miPYqR;|OsonYO$?Kj
z^U`eM9(Tl8c-p0XMS`+EXD|2qmUR{!#`<Ci)m-@Q<x@M(OKHf1S0q?)4l`wkP_8wf
zu@G9gRtx$RnTqhVnOpndt{(yetNF({WHb~8I*3|i(fw{I$;vj?xglrrRK4cjmR4J9
ziOVMmOxJ@~RQcmu7a{*F9NBL3;<S5S6jSX2oRV9AEyCkGqri%#<DVFfHr5U*w~U61
zW5+8cW>7c)_-3P-WW;(KzF>>{vdRFTpHcrkQuBQ<KEt3UE-RiAh@bQG%h;!^DdGHk
zu?kq6BPmY&?mM2`4`>nW{rBH}dlA=IEYWaV@z(-W4+-VGrriG~B2xo-CjETyN%#d%
zf9}3}3Q$=%NE514<s$%>poxYj&JPN+$IBIL7))#{0G%T;{xOF$Y~TUQ_g-(`uCP&d
zXhG#A#ihhAE^&4`Nh<X06Qbc^5Xs%_riA@x3UN&%MWRyAJYMcs{*Q8mXhNdYs#e2G
zK7mPFxf@%L%0~TqF;&C*CvUu&Dn6a%SB!QD3Q0(||MB5^T$cwI2mUrlA+XE+XU;#&
z-mGycl?}S*>rZO!uCSlTQf?APvkFKp&^Ns;xLY?aZx9tY^QRZ)2N;^rXDjNUuejop
zX9g!{J?mDNPT~4{9%fZh_pnO;PoVX`bSa}rMlb%&ooh0m56*_$p`bASUo1DolGwo(
zL2eNs+W$nVcP^+UqN%;3nOZ-7Bl~ktT8X}T${L+<{j<GDmqz|f|L=`$Q&1<*z2ai0
z>f$wnbU>PQ(%$g(u`#G{RI&E`KRWksj1<WFP5cT$SHZnPnEX51FZ$y&<F=sKq@BPl
zHQS#yx7V@niF-AmC#bO>A7Y{N{XSR1NS2(WUgkmus@fP&qr%L9a-)9n)U!+P|F6XX
zc5>K>j~XPN2b!l&*ZAd1=`VvnRqM3oq%1eDNt=aPPu^Mkew~qf|AmAR?!dcGiF7#(
z8Aa6Hx@0fXziNQnVr`R(nAa~`Dt7-3F)$%unZWgLr1J0eGj?mi+@UB12wF&oCCobM
z^9}n<D*6*9U?Y8)>L+qGcl95sZdk0c5##>--8c?h&pI=AlpN{W3$p1PRr}3Brb!$S
zfx?e@;ITn_WRkB|l;z2~Rw)#ONYk|XjegKXo61oDEN1<%ow$d(?1@qcWR#JQc`K!K
z2T8L&r3DzRDf>iBOl{p!c7OiGepQHKzUEIk;6dQvO0##!y5sUUV+T%6XSkYeJ#zJA
z+UPloE6l*@ZR^QQL$cr$LN+hV7^S<YJZ<k1(SxbwR|<>PYd2MU%LR~6OTWJFd5rk~
zc=`O9{6LSd+8-GGO1Ml`xAH*XZKSn)qp1!JX{M{>E<2^@V33*44x%8wtH(~iJrjZW
zp7MjKtM91y)%>(Uxo>2VjD(*)@yd(~BB&QS=^*Kwh249j%#Jzll3#k}!0W!pe1;<Y
z;_dM#f%0x7Wv&UpRjS1!<H^mop!yxN`JgM|af#W|a_1SVE_8wgU64B3%?|THMt~LB
zj2jW*lw3?Lu@S2n-;#m5LwzKd1LgIM1=TMkrp;pa;SuE@+Z)#YzRKTKJ!t8cO=Z6y
zUfH~GsB!2wvC=-1Bog@5JMa8{)nA6CWRU@yihE-Ugpm66yYVZP*&X)7gLBYbsjpPq
zlae>3pj?kS)oJm-GMfgX8(YW~)_#M_Zm33w9p2)xD`<Oza8Za);)OdILQ24ePKwmB
zi-%vl`11%6d;B^{w-%PKsag801k-l13eI|x+mo_90;|6D#H7$iL7CR#>(J1Z?0vV@
zu^u+`44uggk)jq#)=%+CDX~Gm)WZr78Jst0_OgmXseZhe)^Ix5jf~P;lYVjP2_niW
z^UBHQ8hDx7ZLa=|%YxL6H2&qDZ%ckJus<M|Ruzk=z_l80cNQ&i7KxYeXl9`7C&@%3
z<82x4{-x*mD`W}l@!$G+?E_zM{1GEmPfI>FAZX6@%X4;v4lc*(v(R*|%HXc@8q&E1
ztNTv0qFR_(a1M%%roQwCeFQnqO|{mRTT=A??%J2DO&wD%EMjir$~gAq-6GXH#jxG*
z69fE%^OUX@s|{5h893%Co~G}09R<#1p>HXZlCtuVJeNGgfLS`~AwI%>AcGDKQ#*e&
zgd@kT>2iHOpY2^Zcc=@wD|4w=EgsW+7#qBni=oDzNYLjqKrfUAHQ@gI&k$r+n2uc|
zU&A+`35><#={4SXM4@k~4$;MU=)?8p!SRhAYsM8P=fofjIck0|z?7|oxEIIb-DB17
zPu84eo3u}hWKxQw8+?~_BT9L0qOk|$>0m$>iGi^A$BRvE<qrhE$+nr|3<me8pUsAB
zq4vR)&4B=4ze$j&h_H+SKV7m7;NwVQ=%WP{O6`*?)B+t&_X}G1u2*;az;z`sbT+n(
zwm5=G$1i@dfg1>b^>7%aVR497%(~>|Wk2z!JO^mez@F`B=mfFxjFAN@46Ms{Y$a~H
zQxRS!mlL<EqCZnQUj0x^e>BP7%cFYsEmbpte>H$sA9D2bA?~oowC7WaHiz3xKI0=A
zBif28_mQZnQJYk4f02}`x4<lgZLl!Oj2Y)kiDH+PT)~lFT+rQFlQtdLzwPE4Lmsyk
zayz*5Jg4k^5(;To7G2$-B!n8%DFPohVXPWhytIe|h36@NQQXtX8+BsZ6a!NO@_tS5
zq(+k^Q&fw9F3-A9*iFQHIr+2Klr*f$!0nuLY?vFIfci-$E2DUa7|KlY5spE<(s3^^
zkKBlj;43II-}mT~Dlku$$)O{u(fqkEO8i)sG<k`fMJYke87a4QD-Qx=mFH(t@i3yy
zvi;LXI9n`!-cXo6=UgHe^@uwrNuh!_l*(c^nI$H3t;s$bHD5xa=HIu6d4*X^I0KH7
z$wjWz9rd)d6exiBVpsJ8V=o{U3J{wJ`cpQMJj~e@k^@8-hNp|7J_F3)@SKsblEIpO
z#yi6<G-X+Wb;9IjH%nHcS+el9KKWu9tc%oI_ghIfVKw<_=~X2Y0B(7!t{S&uDCJeL
zhDXn;`r&9liR%z3|Dw7&Q+3|NyPBaK{Dr)PTHS#-A>J<TFVjt4l-)p-AoK#8g)&x+
zFv|ie`v+BhERR*9(`_;qVPdLHPFhAua!jvBohjIQDC?Wdtun@dd{<6I#~7U|xX}gJ
zPas$1V#iA{TgIojS+vk*x0Jn`xqi&c)V<~XoQ$8++J?KWCItSBd-Z}LC5lnV0K?^2
zBf}RXp9~m1&s=7kjI26_A7`@ooI)o32j~q$Y&txX%04O5yT1SXVqrqr;$$re;mZ#?
ztlH%QS$6ZOM#M~&`D%Nb@E1~-@J0*p(@EvlQOXb4KWEu4kYhDy51<+5;Z%w3OWc$}
zsKjsg%b`%v9DWlbt2|uB(#;Ec55@^-bJ~Bsu#H}ws_7+4h6=0EZ77=ic;W-3?3ya#
zH9jy$Xj;EfG`Xcj5+i*v#UN0D`Y0O&pwA`sinCa~rW(#Qa&#u1D%s`D?lNK6%6)(!
ztMI8(-juwWNpx9xJvJCwH$iAtO6{Z)swF!&{MN#14XdrFoYivwzG0$%x)BRd3;-TQ
zY+>j9c@d^Y$>r`2=knmjskBrJ@454K{L;Jdgg8RJ3`KhsB0$<fM%mr1IlTo%n37Xk
z5o>MvzKY+TfudBk3{Y;`3x>Ikw%8ZZCIrJ|Tu$9Q&uCfIanO+|aqnZq@GHNg-L=W_
zSz(ArR0X_+PzxtP0|@m%L-&XsO=y9#o}4?g{xPg6M1buAbQD)EvmSM&2<V|kbCQ!Q
zWHQH9i4splGF_jPO8i-g*psco?~e*ry6^U+_X8tv)PSMmzzJAs{q`%7j{PvaL3x6q
zJ&-V@RVZo6D|1PjaQ~b#o#Gommq_ZS!^6Tavw;6|#rK)7KzEi#f<yi0qnc}9z9hP5
zDr#HXF=+%S5dqAHbLA8*%j+Y`z9Tf=g4klHvaBN5!U<+9|2>(?W{HkA*_l2h<f;pJ
zL0US{dDMJaNqiHEds^Zi=RdV%*-wjCz}tS0Hq7pFDn|*>6YbDRi0%jt!)-!N(0;Yn
zcuGVb<ovl3lf85cZyoH&AF(BuIN&FdsM;7N#L&&^EbYFE+X3&wvj6fMir`Ewh`aUJ
z?P>NpIR|h&Nm-n!pGeUnh>f4J;DX9W7&L#~5@YC{#DZB_{`Ab|u#Nu~d+e)ZNp(<g
zY!#D0yUkJ}uAS}Rk2ttY8G|kpjh!E7S1~h6xe%mFt3Eyr571f~s!htMmmtL(2vh+C
z-@m0Cc!JV8rlUyDO(-ZkJ_S@D0ty^u4NIRxMDAM8Rj(vW5fn>;3d`Ea2=dPH&QrrO
zRQ07)vMBh8m2qTB7$wI{nAmvWmhjm4MuidH%mqixYg}()h~`2uPtEh2GpM<&fy-c|
zsoInE7A_?SgxKwUyI=-nwgThz*8YD)(@jL2?YF5_a#wb9OUv;d1GI(J#pg%rCNMP^
zy*yyZ8xf#OXw;n8`)0|P-|LD?cc2!Sge37ao>qeuN(*v%dAIrC)ab6M>4+bSXvnjW
zW5wl5vn4-$=@8%pr(7^LBF>}XF<3+80vF9gO9Lu9S(N3Leu^MWUDr?E%`&4LkMSYO
zW8d`sm)ATHHmzR$Q$EGw6I|<f@tlhZp%Iv}3L;5ttMAjC@)~*@j}{wh8>~q>2Yf;l
zB(Vov2d652%E+F?83$9StGm~Kz4oR=`<u1clS%~lGr6znv{$)dqG_H=eRz@kdJP>~
zisGt=HuO?ZLner-X@n2}A5a|iK2N182Pw??SyTE1c_=a=N_MPtb(se`-(XugqWWfh
z@Z4i68gEf4gGyign<3)pr;)GO3cv<a@1M;S`m*(~?`SR&HN#?<ur=y$Q3ifw;Xnhm
zU>|rw&b}u2O}o3u9y`yGML+00aLFyveTZ?x2%;;m#`Ux&ko(i|@qC>iNxZPtXg7p9
zgEpD->gf*KkfDAkK4A`=atOPUs<lj;$3piRS>PC*70lDBxZRvMTN%UP8L`;pOX)l7
zI}ndOVxFVO-NEnt%H&fhrBSw!&*N;_)`1D$l4XBg`~Nze<_`LK?F&U<(N;y=N&CD_
zRE$|?&&c|^iv{`%9-9cOa(!lIQA#}B+qs|!S~rSUlv|2Cnpt-uFeXmc^CkhENO2(+
z!*DXiQ}4V}E;{?Zuqeo%W+wwtsgF#g&hLlrItaMDxSJ<Tw4v{x><)h^rUT3nl!iA8
z)W_0gOg^sb+RNWKa+PVvG~%q^zQ!aSs*{G6)*JGmo#@h7S)5g}y|CMhFg;f4jY`-D
zbjO940WjQGa@2!fjA0Ow8MB6O-N8XEhH1Z0@+1Tu2`}3sZ9lH7)PbgQ8Rdm%{eR~u
zo^;Nl9_KM0?XT(oOM)s&-~bAY`{rPn^hdE7V()A+ryu-FK3xZ#(`sfR&(9IQbfK3n
z!wa)D)IOM#o7tMRno;+$OT(lvUp5w=t;&Bgz-n9>vVE)5!M^nv+PEZgxd0vTc+Vv&
z`Gp+XZLg((xnT`2U8#ZsEyw!hA&(jyl>3EiDR^7g;QzV0m=`aD&k$hLgPW>%L@`$&
zDJA%2|C`c3sR_lpYLP4LC&sT_diSkJpGg5(6StUf^O_HAHoROj`#c6`^Ph<|9NZWo
zAJSyBk_|X|c<d`3bU2dtO}WIAn$wv{&;;MFlQWm5ZDGaFO#hPJOzAheJFJwFFLk6e
z0=uN+D`;hVWX@NZuzq?l|Lc=pyIM>@NP=dMYB_SI)lXERA+70267H6{&r#HXK>q$&
zncY7zZ<N_4{H@=J05x2rpXJ|4cs5znIx@$2yE8RMhzmO%e(ecx4tVE76#cKUADxEb
zy^r}rHvGD#x#Qg&a|h*sG13^)jMMdEdE~_mgJxgZx4yRzgZ!(le(->l&6U~b%fb|(
z0klS9uHWf3Zpe*r+m+pIu`_f<%5N%Bb=B)+8sgPzJ%($MoFxBXt<;CTPLxqVo4#z<
zmfkJwcP%U_k*@j5a_?VUi^y^R@v<nwm-c}q@SGQZJ_nyN{^-tn=w?%!*)LOee)d$~
rXhlG(cP<U}fK~jzq8!|peNSNFS*}hv{TcYM8y*XxsHspVZyxr4NSB+U

literal 0
HcmV?d00001

diff --git a/docs/akkudoktoreos/about.rst b/docs/akkudoktoreos/about.rst
new file mode 100644
index 0000000..594dc9c
--- /dev/null
+++ b/docs/akkudoktoreos/about.rst
@@ -0,0 +1,14 @@
+..
+    Copyright (c) 2024 Bobby Noelte
+    SPDX-License-Identifier: Apache-2.0
+
+.. _akkudoktoreos_about:
+
+About Akkudoktor EOS
+####################
+
+The Energy System Simulation and Optimization System (EOS) provides a comprehensive solution for
+simulating and optimizing an energy system based on renewable energy sources. With a focus on
+photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements),
+heat pumps, electric vehicles, and consideration of electricity price data, this system enables
+forecasting and optimization of energy flow and costs over a specified period.
diff --git a/docs/conf.py b/docs/conf.py
new file mode 100644
index 0000000..8d65060
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,48 @@
+# 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
+
+import sys
+from pathlib import Path
+
+# Make source file directories available to sphinx
+sys.path.insert(0, str(Path("..", "src").resolve()))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "Akkudoktor EOS"
+copyright = "2024, Andreas Schmitz"
+author = "Andreas Schmitz"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx_rtd_theme",
+    "myst_parser",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
+
+# -- 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"]
+html_logo = "_static/logo.png"
+html_theme_options = {
+    "logo_only": False,
+    "titles_only": True,
+}
diff --git a/docs/develop/CONTRIBUTING.md b/docs/develop/CONTRIBUTING.md
new file mode 100644
index 0000000..e4fbc3d
--- /dev/null
+++ b/docs/develop/CONTRIBUTING.md
@@ -0,0 +1,48 @@
+# Contributing to EOS
+
+Thanks for taking the time to read this!
+
+The `EOS` project is in early development, therefore we encourage contribution in the following ways:
+
+## Bug Reports
+
+Please report flaws or vulnerabilities in the [GitHub Issue Tracker]((https://github.com/Akkudoktor-EOS/EOS/issues)) using the corresponding issue template.
+
+## Ideas & Features
+
+Please first discuss the idea in a [GitHub Discussion](https://github.com/Akkudoktor-EOS/EOS/discussions) or the [Akkudoktor Forum](https://www.akkudoktor.net/forum/diy-energie-optimierungssystem-opensource-projekt/) before opening an issue.
+
+There are just too many possibilities and the project would drown in tickets otherwise.
+
+## Code Contributions
+
+We welcome code contributions and bug fixes via [Pull Requests](https://github.com/Akkudoktor-EOS/EOS/pulls).
+To make collaboration easier, we require pull requests to pass code style and unit tests.
+
+### Code Style
+
+Our code style checks use [`pre-commit`](https://pre-commit.com).
+
+```bash
+pip install -r requirements.txt
+```
+
+To run formatting automatically before every commit:
+
+```bash
+pre-commit install
+```
+
+Or run them manually:
+
+```bash
+pre-commit --all
+```
+
+### Tests
+
+Use `pytest` to run tests locally:
+
+```bash
+python -m pytest -vs --cov modules --cov-report term-missing tests/
+```
diff --git a/docs/develop/getting_started.rst b/docs/develop/getting_started.rst
new file mode 100644
index 0000000..8256c51
--- /dev/null
+++ b/docs/develop/getting_started.rst
@@ -0,0 +1,84 @@
+..
+    SPDX-License-Identifier: Apache-2.0
+
+.. _akkudoktoreos_getting_started:
+
+Getting Started
+###############
+
+Installation
+************
+
+`Good installation guide <https://meintechblog.de/2024/09/05/andreas-schmitz-joerg-installiert-mein-energieoptimierungssystem/>`_
+
+The project requires Python 3.10 or newer.
+
+Quick Start Guide
+-----------------
+
+On Linux (Ubuntu/Debian):
+
+```bash
+sudo apt install make
+```
+
+On MacOS (requires `Homebrew <https://brew.sh>`_):
+
+```zsh
+brew install make
+```
+
+Next, adjust `config.py`.
+The server can then be started with `make run`. A full overview of the main shortcuts is given by `make help`.
+
+Detailed Instructions
+---------------------
+
+All necessary dependencies can be installed via `pip`. Clone the repository and install the required packages with:
+
+```bash
+git clone https://github.com/Akkudoktor-EOS/EOS
+cd EOS
+```
+
+Next, create a virtual environment. This serves to store the Python dependencies, which we will install later using `pip`:
+
+```bash
+virtualenv .venv
+```
+
+Finally, install the Python dependencies for EOS:
+
+```bash
+.venv/bin/pip install -r requirements.txt
+```
+
+To always use the Python version from the virtual environment, you should activate it before working in EOS:
+
+```bash
+source .venv/bin/activate
+```
+(for Bash users, the default under Linux) or
+
+```zsh
+. .venv/bin/activate
+```
+(if using zsh, primarily for MacOS users).
+
+If `pip install` fails to install the mariadb dependency, the following commands may help:
+
+* Debian/Ubuntu: `sudo apt-get install -y libmariadb-dev`
+* MacOS/Homebrew: `brew install mariadb-connector-c`
+
+Followed by a renewed `pip install -r requirements.txt`.
+
+Usage
+*****
+
+Adjust `config.py`.
+
+To start the server:
+
+```bash
+make run
+```
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..2986047
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,17 @@
+..
+    Copyright (c) 2024 Bobby Noelte
+    SPDX-License-Identifier: Apache-2.0
+
+.. _akkudoktoreos:
+
+Akkudoktor EOS documentation
+============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   welcome
+   akkudoktoreos/about
+   develop/getting_started
+   develop/CONTRIBUTING
diff --git a/docs/welcome.rst b/docs/welcome.rst
new file mode 100644
index 0000000..9e7ac1e
--- /dev/null
+++ b/docs/welcome.rst
@@ -0,0 +1,19 @@
+..
+    Copyright (c) 2024 Bobby Noelte
+    SPDX-License-Identifier: Apache-2.0
+
+.. _akkudoktoreos_welcome:
+
+Welcome to the EOS documentation!
+#################################
+
+This documentation is continuously written. It is edited via text files in the
+`reStructuredText(reST) <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_
+markup language and then compiled into a static website/offline document using the open source tool
+`Sphinx <https://www.sphinx-doc.org>`_ and will hopefully someday land on
+`Read the Docs <https://akkudoktoreos.readthedocs.io/en/latest/index.html>`_.
+
+You can contribute to EOS's documentation by opening
+`GitHub issues <https://github.com/Akkudoktor-EOS/EOS/issues>`_
+or sending patches via pull requests on its
+`GitHub repository <https://github.com/Akkudoktor-EOS/EOS>`_.
diff --git a/requirements-dev.txt b/requirements-dev.txt
index b47030f..038a491 100644
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -1,4 +1,7 @@
 build==1.2.2.post1
+myst-parser==4.0.0
+sphinx==8.0.2
+sphinx_rtd_theme==3.0.1
 pytest==8.3.3
 pytest-xprocess==1.0.2
 requests==2.32.3