From 386392be88d37e7cdb3793241589e472b818fd75 Mon Sep 17 00:00:00 2001 From: Susana Hahn Date: Tue, 3 Dec 2024 16:36:16 -0600 Subject: [PATCH 1/9] Mkdocs for the documentation --- README.md | 2 +- doc/Makefile | 20 --- doc/_static/css/custom.css | 33 ----- doc/_static/logo-dark-mode.png | Bin 9697 -> 0 bytes doc/_static/logo-light-mode.png | Bin 8934 -> 0 bytes doc/conf.py | 128 ------------------ doc/content/encodings/index.md | 7 - doc/content/encodings/instance.md | 32 ----- doc/content/installation.md | 41 ------ doc/content/quickstart.md | 11 -- doc/index.md | 9 -- docs/_custom/css/extra.css | 25 ++++ docs/_custom/css/mkdoclingo.css | 49 +++++++ docs/_custom/css/mkdocstrings.css | 50 +++++++ docs/_custom/javascripts/mathjax.js | 19 +++ .../overrides/.icons/potassco-full-logo.svg | 3 + .../overrides/.icons/potassco-logo.svg | 3 + docs/_custom/overrides/partials/logo.html | 29 ++++ docs/assets/images/potassco-full-logo.svg | 3 + docs/assets/images/potassco-logo-dark.svg | 3 + docs/assets/images/potassco-logo.svg | 3 + docs/community/CHANGES.md | 1 + docs/community/CONTRIBUTING.md | 1 + docs/community/DEPLOYMENT.md | 1 + docs/community/DEVELOPMENT.md | 1 + docs/community/help.md | 44 ++++++ docs/community/index.md | 32 +++++ docs/examples/index.md | 18 +++ docs/getting_started.md | 35 +++++ docs/index.md | 20 +++ docs/reference/api/index.md | 5 + docs/reference/encodings/index.md | 5 + docs/reference/index.md | 19 +++ docs/reference/problem/index.md | 5 + mkdocs.yml | 111 +++++++++++++++ noxfile.py | 21 +-- pyproject.toml | 2 +- 37 files changed, 489 insertions(+), 302 deletions(-) delete mode 100644 doc/Makefile delete mode 100644 doc/_static/css/custom.css delete mode 100644 doc/_static/logo-dark-mode.png delete mode 100644 doc/_static/logo-light-mode.png delete mode 100644 doc/conf.py delete mode 100644 doc/content/encodings/index.md delete mode 100644 doc/content/encodings/instance.md delete mode 100644 doc/content/installation.md delete mode 100644 doc/content/quickstart.md delete mode 100644 doc/index.md create mode 100644 docs/_custom/css/extra.css create mode 100644 docs/_custom/css/mkdoclingo.css create mode 100644 docs/_custom/css/mkdocstrings.css create mode 100644 docs/_custom/javascripts/mathjax.js create mode 100644 docs/_custom/overrides/.icons/potassco-full-logo.svg create mode 100644 docs/_custom/overrides/.icons/potassco-logo.svg create mode 100644 docs/_custom/overrides/partials/logo.html create mode 100644 docs/assets/images/potassco-full-logo.svg create mode 100644 docs/assets/images/potassco-logo-dark.svg create mode 100644 docs/assets/images/potassco-logo.svg create mode 120000 docs/community/CHANGES.md create mode 120000 docs/community/CONTRIBUTING.md create mode 120000 docs/community/DEPLOYMENT.md create mode 120000 docs/community/DEVELOPMENT.md create mode 100644 docs/community/help.md create mode 100644 docs/community/index.md create mode 100644 docs/examples/index.md create mode 100644 docs/getting_started.md create mode 100644 docs/index.md create mode 100644 docs/reference/api/index.md create mode 100644 docs/reference/encodings/index.md create mode 100644 docs/reference/index.md create mode 100644 docs/reference/problem/index.md create mode 100644 mkdocs.yml diff --git a/README.md b/README.md index cdd189a..dc38be0 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ fillname -h To generate and open the documentation, run ```bash -nox -s doc -- open +nox -s doc ``` Instructions to install and use `nox` can be found in diff --git a/doc/Makefile b/doc/Makefile deleted file mode 100644 index d4bb2cb..0000000 --- a/doc/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# 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 = . -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/doc/_static/css/custom.css b/doc/_static/css/custom.css deleted file mode 100644 index b5215ee..0000000 --- a/doc/_static/css/custom.css +++ /dev/null @@ -1,33 +0,0 @@ -div.admonition.example { - border-color: hsl(257, 20%, 50%); - background-color: hsl(257, 20%, 80%); -} - -div.admonition.example > .admonition-title { - color: white; - background-color: hsl(257, 20%, 50%); -} - -div.admonition.example > .admonition-title::before { - content: "\f2a7"; -} - -.sidebar-logo { - margin: inherit; -} -.sidebar-logo-container{ - max-width: 20%!important; - margin-top: 0.2rem; - margin-right: 0.2rem; - justify-content: flex-end; - display: flex; -} -.sidebar-brand-text { - text-align: center !important; - align-items: center; - display: inline-flex; -} - -.sidebar-brand { - flex-direction: row !important; -} diff --git a/doc/_static/logo-dark-mode.png b/doc/_static/logo-dark-mode.png deleted file mode 100644 index 81ed997ac70bcf9c2cfe1fa3b484808576528db0..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 9697 zcmZ{Kby!qi)b62&4ut`61XMy|7(zlCM5IGPVx$CAV5lJ^WTaG(P)Vr)9FQ8ihLrA3 z=^kl8O6rck@80M6{<(jg=RD`#d%b&|v-jF(t@oS{dOB*fR5z#q0H9TW{LlaZh;W1> z7er1#&MFRy2`5U|$EF?tKz;4sK?HnFVI_b>9tLX40Ji_;FTw?>gOauq0F*>ipIegw z0JoR=LnT8WqV3r$&(Zc9?Y}!x&N&cdjLfaMoS8w2WQkNLDi|}sT$~H!5JymPG8cU3 z%nqs%d%;qaP*I=%TJ47V{D3sh@ncJ9YTT{*15I9HmR9NG!N!nf@do3|6QRqawd3oJ zjrj(+qo!TUwmT=dgLi8ASJZQ zp!H{ev=NT3Y~E9BW{^_pn7iRkxaB+kV&-B_Qb;(9K>3KzId&74Y;Gs`8g+S1j}pnWNM-k^7C4Fx^;*iK;%Dm8;+Se^-F+%3cg7iDa;7&0PR zTaCdhmbjhpZ)a|1%3~An7g|~wkexQV#beDgNu1MAVcC$ole1n)6s%kz~=LhzfmGltxdT$V=6@cWEFT z+2q%!rQbH34^k?N-=8K|-ZI9W`gS|k+B^-jz4m7D#Cda5y6QmVSnYg(s4diB zeQ_i@xtfi1CYmB3JXJKDu>(+9kQ)-uZ-@iQJ|vxes4cZ{Bk(+br~iz4HhQG^nt#Sd zzBsJ_qfdm|pmr}Q3D(H}SrRTh(kl6Fs+#B+|GWn2oDC!Lnn(%CaWr(A3><$Nk>0nh z-Kcr#kA1j6WJd{R46Hlq2*g?}?t1--7MpwivwK~==~n$Y1l#2*l1KJ@se9|^`2xP5bgO#jq43L_JHwuV zym^u|?Qy27^##GxF$2nn{Jq^=@M=9*NRfJ2R9;$HJ4d-w`Y-BiFN zY_Q&pvT4@BdkH&x0)^PRB!VUm-^4Qc6p<}BV3VEp$0K)x?<~OdvD9@Ql9zo;KlNvc zCT32IEbzB!!4x=N5q2zlhk31A{c2rvX3g(>DPp>^^>%u~a0#TED+(t$h`KM)sFtPb z-z3o+bUlj-Tf#F^ASuB#cFDc*s1ljpBz710O(Kdd*JT|uYkQux4$o^kVb8#7O+? zxI7+(BGIaL<0&YB)WZ^~B)1AQ+80q;OEvfZOg?}o@g=aoAv(b<(=l{*M~c1a_$m|2 zn?{p93mcC@XjtiC{m7Sp(mHHce^R|SQ(T)8;?V4tL-Dbdw)Up=b~G<>`-(!yzzi(l z#8Hiz;`$F-1(`2oYpm}!Z$&*I&67eaV*U7j>wPhjcZD>eXJB7+#-sS@_`YuD)kY&& z9XqNa?jEzf-CXjc*70C(m!^l+i+Qyb3OZyf3t>s7UGa)d4{NL)EIm?Dg(pPMYU>C- zQCjWKxQdA-eIsT^B*xe_Q^M|$z$J;B>0Zvj99Qr`fPJT@?O&CxJf<~T*Q}4rHP97z zI%p9jxVveq#+oNDq~wQ2Q-;N5%(4ol;CtH?4sN$om8joRR&Qru@FYjI$wesEFUq1n zMh1*h^*D8~!$MkaPj;*pt~96n@c@II^bT|rH=F4uEaqa&58jd#_pEYM-Psx>uwa>h zt;Mh@SSk?2P*qkXra>bY!b<5&% zHW5_I?HY0u6;yNn#Sm00?J?Wrg6(*bLJiPJHPZ#u_?IR3lL28CbL<}Rw|YOhj8;LT zJ%|)}p!1d1A+sqb?f%>QQefcu+P;ti=hj-2G34NNwb8c zQv>8{AQ>l*Q+uIQYT(h*ei(!uuJxfu%>0)H0256R-jb&tS=jF_mIVXXn^&o8tCXiK z(%9k!h!m|Y8jAhy#ddj~wVIys0erDNV6O^2mIQ}=N?k5MPd0&fYuw_BYMFgyc*;yB zdzv^AM1b%^{GnwW3Fb1&bWN?*veqWl%T$pITP56dD0TNE>nfJ^<^7L6BGaIzZ_;PQ z`Jrwnl2^fHo=_l>$bsDp+`M^Maq9(lz&o`Q`DPivKWPsTEaPv+ujK*Q!?lly63Yrk!8jpHbv?w(V)!fko z1p7Z(gKt^%;g&K8NKeHw9a)p|>E`@3@4!XHPTH<1Z&SkDkVQ<4MORte5w6jp>z(p4 zO``_(QVC0!!6$urGYKZ>Fm2bRGXtR9|KrHIP65QWPVLye<^cc=#-Oe#>w821TCg8M z-2Jm8nj1jh?e`+q5F#`#I`N|S@DM=JG-Z}Fw!$|4U!#2DD~EM0;2(#!qBQ~1icQ`m zRd%RKvD(I$lA_c>8Ed$?x&-WWkW;;<96h_HC9dYrpmgo49Si`dhW}upO0L3ATOR0b zs#Bz0^)$Ll_{_)v*IPZseyJ1(xJr=qIcjVBUmNcyAJ8F2G1hE`ZwHqJ?DtkyePwc} zl1icE17I-kG6DDPu!Dz>bYeek@D%?;?Z-w+*uEY=eaM9$p-e! zMB`7yK2<XpRdu!X-Tt~xYg%QDNpN*_D|P;)lk&q0+6%bSKQPU&Hdey@)0;=`j}(E;sc zV*M=79JME&q?3R(V)8Tnc-Rd+09O>Hr`oOjBQ=A;Bokzqm{9H-u)tFCD&KP!V)`-- z>(6qoOX+TitZKM; z3Fl7Jdk|ZXYim4vNXl`$X9CsrSV0zQ-9F{~%Ciu+j=9ZWS{-c*D4>k z{IOZCu;r=~^JL52H-$0{l3)|RsKBvVbqQ_@WR?Ah(eKG}^NItUNXOBuWB&l=#>;GM z{m)n|mP@|^a`$Dz^)hsXH&=qjaU!C}-=--vK*e#9wNSzMvP@dTg=BkNvzjk#%C~L1 zpj=F)l!b0chFvfi8e&l>-do<=Sv5p`elqLz)lSq*qiu@?r0QEBVa1Up*xGZKffxn7TsSgHq)&is%0pp!VO~Fv&9WP*w`Y|m&}eLcqDn( zKDWP)x<7I&R=YS9x+v^jpJ09f6i6J?`^vTPNaL3jUsb=)mf#t);KBM?Z9Duh*uOn~ z#!5@Ekgb%5V>4PRRJhURy6N$SfkasL@!^Nz!&i+I8V(|w-?>*x^T-_OmlHKv%xj-D zjqi3l<$q4j>?2Ks(LwTZT>XWWeFuF0FefUc{T044#+k`IEyxlx<%F&nQc90@A5RsA z-sHEto}b{Mt(leTR(bP0Jz#A<-8IWC@AA@+UR?>i`$7O?`_|{#)UFMfe>DVhFz~EY z<8>(e)o{m(S>SmVbRp~+#|{3rSi2YVeg;vrE2H84HpYG7aQ;$TX{B4zE}YfUNjwp5 ze2&RepSWhA?R9fusC}g|zQT^o@lSI1>VpxE_XGJO-k8r6GP!rYCi&5)ek)G&gPaAX z+&rJv3FqLo0&2eBXdI~KZJBL|H2$J@gG&E$ZwKR>VT}BPxe>Tex&bmk1_OQZK%JQ z;)fy%GXnTZ7UJwzAv4uhYpR3RcMg{VzCW56x#Gyty5P{?h%pN2r9Upj3%0K%h6G8& z=|~P?@MLFq;jhXKovx(DoNgv^?64z+W24mhTE2&*xQ8$)C7ARdOR5=7 ze9xat8?e(+q51Xb!l(nO!~sFN$>eIhBoNkc#%A+6Bwq-ayV#ITyn1t~|25c;<;)Pt zGB)E!RISaeWpqb|Yo-6bW$tVOMbZ83YsiXW%q0mC`eCF~xfs248-ImS;A{Q|Swf9B zcrpN1eT>%9QPcaKP)m_Kgl>B#YyEVhFKSzd=V@P)0oeN1+Pu-9IrL4ZCZw9&@j6Q+U`4Q(_8D19dVKHwj=$3Y12df6VGL-pVf{EV zW)}bGB?6LDD~7jGHr5yc0o@`iHd~|ocIwm}?3i4av&b`koY^ndbP~PKmiJRe=L91l zxja7>a+j;1UDd*PLIdiOd@42YkwMzvn@wB49qI>ODnzI>_W_=i3_(fqDss3*i~c>@ z*?1s6$_>|o@jBe87pczAEaOW`a{f@0)j@pxGB%9RvOP<;g+*)5I&ODgVc3Zd9t|$a zM-IbuysPV@w`&9lPb%XpNwE((J=iW~N9u4#@`yZj=&yA9I)MICy34(c>^RMp+^-Ce z`YjCzKz!&FNZd|$(3 z`J#KwGijKE7VwDu>yP_y1|w~@bI=jgZBHoV*@=M4`x<5CZaCwMS=O9slOZDwwFz!u z<~law-X=7mvX`^MVNY#frGYTs8ughuag#Rr<}V#nd)HVF=Dh~AX6pNWBLEd(Fb>|G zJ+y5%!<>GyI}3uIejpxI@MH$I}9ear`o3&S%{FbXNa>zA(fU}4iW2$kCX=^<2 z%Qp3fOAyCnm|aQdH^=z5J;cuJ$S>!;d6F~AcXi*uc5&B%1$jZSYSo*;{z5W`!G#Jl zOOcLbK(+2G{XH$Q>jGoZrMYVodE4R8it7#G+|s}TLN*=oj=tt+qknur#osfp!69c# zfCT2_G|<9I^96hfxjb2Dtc!K#u5!acka5G`IXy+ZEZ&PSeePXZF{S zxyv4fdi+5MUo&fU_sc?RY>-^=19dMVoV_U&?x+#eP{k zQ)mTjkIa}^BC}~e+VoSH@^r&-NA32;cwT0fA5D|tb>9o}w5&~+W&kuM!60|2n8(0LH=OZ~BEW;`} zdfwwNgN}nR4DRdQd|veTgD?qSf%&7|*v4(iA4lCB(dSp|SLcjri=!z#qj%eI=|kD)*M2xxSK4Dr~O?n+xjUVGI4~xieMY&#IxM?dMC>Q z?lV*go3UrPwH?o6u`u7t|5B8ue`?$6OtgaXZaiz2d5n+bS!cSe!$w}MnN&NPtEyxS zQ4tuBxyk!**{cwt6PW(o#G-EKv?Y)*82I@7mw`u;Wt z3%A0Ihm(M_Jz^sy$hf0+KmCB3xwQ(8*_oLwH)ReK@W0p`kKS<{kvF(XF}|?)wQfgb zd3^qiJ?ev}?k&MeZ&q6x$p?#@49_i>9mOUBt0)t82-VH?Zkus#0BF072Y|9igG7LR zB$@>1y`e+_B;F6A17MDXRbn*`dH^&PFd_kzDYcSheuoGE5G1XC{on}%tPF(HAW(&e z|Lf0%C+sG$Cx-viIpJ^l+HjgYEzm^&A7TsnNB2hGckn_NVCncLw93w0Ty}M-3!ph! zl#cUZ>c5qZ+Ljl`8PD_5g>A+lfiv*N1eN?{!W|9xo*Y)C&bvqkzUcxx&3olsu8Lol zh8ImQua5Nx8oX?*w~lMRnvF%v?VU|;pL%ZkEv_q12k0wR_E!wrCm;Kt-JG7Fi=*?v z50Di`mF?EmY#vt*!(A2KF;J0HDp0r&0-IX3A z5cz^<+beyeb9Z-jK7YKi?srEU19({G@)oAT6w};#;NI^QPJwD*V2`4+Q~%p zhVYD>923uvD(`Je`S%d#zb`I++kb4zn)P*5P1YXk<|qdN~qG_;qYVHcOep!Mb(cL7@|u7X{)dpSSX0 zgH(EEuN24Z=0yAb$W`?djsz*+tqYglH?A{6&thw8%PaQNPuIKO$Mh_fxKuq#a>d#) zmagh+w98KZ4K{#rVVo+Yeix*gB6DZLVtUq+_Ve0m?1fSsax@eNg<33?=^VP(wK_A5 zpQSjymemi^9>id!b3;BGDbrQJ?i=-MSfn`C7-|$#;#@RTR81 z$bRmx&>pPNctZI!P2<${AW;`XBWe<^neb=Mj0_UJac@*_WFdinxh*onUcP+lkF1vT zL_ttgWNL|_#Z2})iRA2|;HZ*tcOzvT3-JJR949LnxC9%X&k1gVry`jN~! z1BCmP(U;wI7jG~zEKW?8DXdm$f*&%Qph%2hAu^W?g7()vSEhnNgXmy?tOkw^c)t~^ zPyuLGLatGf>35qzTq2CWfqC6|#}5G7eRXgDy@x-Sf`7*wct6f16C@EkK{d-&ubvg; z5Mr#^St;QG7ls7@$f|`1R=KPMG?vq3kgT_X6!?g68DtZ>=^#glD!pY~H-6KVj(xJrXV6YTHc?&FuF;927Tct39ZkZVk@ON&yABKUx`9E9^hz8IjE z4T-JR8qj5v$NNbDz}l6n);uejKN#49rWN2>7@(h<1#P+R+4>7U-xR%m+-pw<8Boln=@YJjOTvaR$rq z;03+ZGxA6PnvDgt*hYhY^O76T6cd$;4_evL6uCzRz|gkA|B-yV$&4&HD>b@tYnB9H z?JZ%3$NUUntGf;WB=~Dc0nC{u0MIPp(Fd~$g~Q$&(stT}X95Z!ICMB9M^q*(LSac} z1)3jyGLJUzveJa{5Of;4Q5g?kvecn0KjqGUgT)xlheLgekOjFUFmYTmINN)W&6(2p zzosV|s^F)Fo<(GUB2TW;vCc0e_~gA+LjdMnsQ2v~TI_2qQwm|B(HIEenw}d_Y0?6K z^j!*gO6)KnttKtZC>MSVh?afF6Gud*S?Z11{RovRy1DBj0N57=oCW95qI?Lqn=Ov@4Jh~?%-M5%2tU3kp-!}mE-xkX9 zb&b@vrbA=`n5?|AHuY2!>~Vru&%fX?mP;as`|}Bi!Frmz62M?>e>LuB(9Lk@(|Zsj z2oKlX%xaUWSi14)Ama482-~Vm7TF4sQR>@|V4Ict?-v5kKb@v<;`d*UJ&7Vbm@FjM zicjfVTAc>j20o6Tg3&X(j{O6znHVIk1LcF3yd6x@20xdPz)DQn#!^s{+Rky@JKWl* zQA7E*S{{^(C-1qlu3E3^RiFJ?Z=c2T6-}-;KI+Kd9o- zYg4Cp@6+p_1f?*;6^%@Qz#$r54)3p(#w1#QN}lEgI~Iykq%O9zRmb~d?Pv*OWA}|_ zYhspit4GR*yLWhYj4#hkKd@id45Tj~7c%51w91J4QR9`_yY&2X#c(J+{tk=X(fah# zXruohHSRxSf0uKwZqhL+{ywj{?i{~S?^5<-e9ax3MA)(?GuQ8WPpsM({K$-@@1eyv zYcUA-N2?}0wTx7_WaVE8a=koR{&ck;_nqnQi&3~B#VjhwL&%gBaoY0Ahtp3L+!{Kc zkyrKWh zR2#cuAq9sW3f+TaWzh;`L*skU;RzSPCFf3Xv>6I z>Sk}-oP^pQTTt&f=GQ(gH_BfwukydzgeXiP8vE@ja$H6KE-N@JTM+cnc8XC=hj;rN zfZi<*y@dXDLKN{u(trOs#fIcz1^|lRM2ACDAlo-_1Y8}&>mW%;>a+mG*ZzvBGBQYO zVxW5ow@U8l5d0sSvfUaxK-f;j`w=!8d&d9itviWKqXdYc&vwLCY#v>b0O*_jh>loP z$0t&UD?#|AUxgO_bphB>K0j7vRkUW^F!J9FZvg{s}|#2 zi)psyP9^vr;ECs7?4I{fPrY7c-%e$LrqNX3u4RVLUm8j3#=Kfr$VZ$mXZvzF|Bsxw z7A?H!c=h@;Q@PbkCbDA}hiL3OQ&`oL88wm(@**T9n@c~PH!bou}+l-*L(&p+Bc~ToPm#J?u37pRBb&rE(@69CctF z$L12-K(K4eu|fHChQ#)feL;7cM`407Jh|}sw-Yq=`8)2JdNcVj-V`8Eu*AHlF`?+9 zr)F@X=4z&H2(|PuPg8pn+aPXR&c1GTqfEjNP5It?sOUNG3>*%1cBkS^`*3g~PZty; zcI~Hgu``kMgjQn3)LniY?Nu}#FQHNe%RfwiMI@@VWr|a9_qJtnUsKlY&ziX=AT`m; zO@CiIGjp0rIX5nqS7k0Wn)?~d;cEBhB!kROh(tcAKnBIS7MmN^?vwurESI3T+Ke+# zqTx60-ycvjaH+hJh$s=N0Qm6afhnL39qXhG@vx`*ZAemc0=;2DNm}ELdrThMB+~x&lR zRw;S4Vg^mUv=Vzr`@!WUZl39PR2Uy4=aEoM;7eLVQvo2gHN z7`zH1e>nFBBief`G=B7THTUx42_zk*sUO%1Kr&VmAY5pYxoUzVkNqBEtu_Zx?BYKZ zuSHXf_O;Fk@}-+i8a0m^HeWYV{$$UFR7&~q@&etK8wNo+#uf9G(c+rk&DLxsKp4CL z7*`n`juR?VJO_L&ZXv(MPH;jVpLx@93nW8I3el@pC56ub4+Ldi*hLhp(8U3XrW&e} z4=2ZnVPuAj)Mbfi>PnW_s?rKd8J0Mb)jN0=dwnJFbDCPtE%d$tfU*&U;)8mvkK-fJ zL`^fL93vxY?ExYrX}$nZ`Nl{$f);0mDn47FZzln)9!Ag+JcB>AOc2=WAJsO14889a0s%gTpd%`qv2pd?9O(g*a*U`Fk(6Q>>1=$jHCP85t!0pudb1wr z%s>7{u60eR>dwJ%FiM^OKzWcT^bY=rm6O2hX=h9fJXal@wLulm&tOx$wSw*4|iu!bdj1Dh$1OFAR?FE`J8=#nJ*+@6nnI zEl@2TN-h=g#=|q>N6T8Db#l?(h3@6kwt8_QfQSJLpOI|EU7+{O@wHdxQ$bM$jFG{h3)p|9ADsN1yCZ5(avJmL-J{ZaKNp7zi7r zQvH9m=F=OvFmM=}WH`}Md|Ac!6TMOuj1&?R7Qv$@6@<7nvknIh{(2dDn-Qs)1bWZ} zQlhYWX=bet!kuP`Ci47rCZzYuj7TwWclYKlN$v9KR#$9X1ll~zIPu0U?k~FiimyVK z7znoC>Gl`v;jBRjwg%9XmNuWSQWI1U33ZL6^(!;3h+dfiS1j{;v^n{XXwEx{o;%(c zt=j*tbs9eWHd1>bh7;bd_-~gP=WrP%tS8_ybLxGBJ)MiFcW^zpz%I3~yC$CS&q&9; z^&3i6H!Z}S>-Tx*YW973pSD_IIHGoC=?-2SsO@;B>u2XCOo#|k;{x|wj{ z$ASAnh{Ywc^6R&E?mm?Y-(-$5&w=M3b$NyPznMW)J%#c3AY#w{o7SaVY zcDzUsfXH7~?>aQ@oYqU+#K>o)dTeu=_E%hyyp6v;7-l&9hww)hpsuR(5UXqz^nU=n CT93^D diff --git a/doc/_static/logo-light-mode.png b/doc/_static/logo-light-mode.png deleted file mode 100644 index d2ac73df81da80b1e28398ecee1ad8385a2740c5..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8934 zcmajFcOcaNA2|Lxdt?ilsf?Ue_I89iva&fNMUj2>8JS7OJ7jZ|5J$4_tjNsX#i6XT zMTj%LFQ4D<`}g;c*S%h^$9g>;&+%B#i!;>Mp`+oX0RVvR!To#2006;)S1A<*2qD() ze+F;Vp7$+%0DzX|@`3F(Mg{XfW(z-Peq*jrgFkJ0E)23 zgp)R+&qd()83u0umP#?TfMNWK?hHp!<7hJW<7}9PKBvV^x_jK?`tQVi@GCUhF?Em|7S77k+~gd4I%!w<_)?Ez^qz z2Yk-XxUWwOi|dKxjR^YHFOt@;%(w=}w%7efI^&oak@8y86STg+CaLa^y&moer&65l zwsKJ`qpj0c=bgkncMLKoxyw)RBz(61!X%j!s#oc;1_>{7GS5bY{G5={O0bzhh;`DD zEkv>5Q3tNGwsF(~!scZaY5oEW8f5sUzuzGzRdTa>F|R1|!$thH9JvR zXw8yzo$&E_RattLe%pZ@iz+I}kJZ61t^-g;b=eL4u9z#a{>Vsf|7DZR2~+>mS^wuo zSXo8(L3Bo-T&gx+w%)DP6tR=paWrVvM5NJHI}*svmV%r(OQ5^l!`6Xtw(G{Q`OzB@>1DYpDjr|`ejAN zYuJ=U;{Ja77DtoOd1 zQC#{C1i(xo4$9?Y@hCqOY^OyfCQMl zzl(K}eY{C`KqVry`;NpjwKl`n^)wPGMnZo;gR^>m8sCX|hKJNka~`$Th>xZb^1juG zN{24|=!AA(b#mJ@y6zH2O! z=bhnTZBgV2)rYa+q%C!$0Wa%WC1D9McI-NB5C+=y#Q*NJyF;z~Gm`HJ=9G8B$Z|xU z<@g5p-8q4)cSgkQe5whnWD3_MOOR^%%%&nyV))*Hcu{|20g#}jQww#zuw^ui<99Z_ zOHa8}J-X|-fqYu{Oj81we+5;)UXT9Oy<_1MdxPB9|Ag=N_378{aQkP6SG1K5V`!9! z^%3D3R|3;nf(5zFgW3YjIAu3&sW^V<(v8J>c>L1_;Ed9noBc)M|4nCmypmJE$fNaS zy`Gfxinx05wzb7%AirD%VMrK$tTUDhhvBI205)H{yplUeYX~BBxofiFUgmBKBx@O- zXQs_EQ-YO!-(yxX!`PnNOZzK#D zd%|96-pA+X(HVVL{0V=$k7pp1BJHID$K%4+33L34hv_CzBdhrco&=FBDNJ00-8$hZ)T?OWTX) zk;9hgCH{azA#MN6`dIvSqFt6U92%K{RL3G^ha)TDIpcGsb2wlK5=Y^o1s1XoCxc^K zuL7yAAbyIflX@>7)&7VI7`GR=Kv(bIUTtlEvDBIp383kr$FV#rR^*nTQsHT*9TiO4 zQ$1nb-n!gCtyS+uJKs&3J-&3uI;QZSn0saJcPIDonV=fd{QvuV(}Lhv3EeLT=178?PyAQtiMQx=Is%98}QFMISZW7J)Y)CK_7TRjp>0e|TMw7l!FuO$TpFih44 zQI~vgYTK1H+{FNOjG)p>PkyW@#NJ(WJPXlm?0@vBgCYrU5%iw=U^uXL#g-Z{6rru_ ztgtP^wXP^6WJHS`R-an=0O8(bzL45?29ZvsG~~y%D*=AYz?(9UszCCYsvu0Cg<|mO zFINZ<<2QXZ6FQwZL2G)W$D@M`0(fr-CFLk}tswGEdN=!PQRfS30MIDC9yBk@DKVXB z`X_}U5_LX|0f4*+EaQ(7SA{fI_t;vaUz2;sn(QRN2l*UzWAD#+Od(DJB*S7n7CEo>|k`0gXEN#d}#2U|cco8}9A9YXM0kVoTMZv#T1hE{%TXCcG<6o zbk-{oA%;gSqQ5@4&dg!G+FMS}*tSv1r^lsRl>tlpL&Txhk{LU%izIsmiM}KX*&>d8?;&7Lo33FQz_=>6U1dPYa(h z{Gd_zvG{gnc4)`Qan=;SamU=JqNr=?*-xokKKa(-+t|O%OZ%~+Q8wkeOIhBfwK3Hu zXESA~oQo}SFhs+{KP1&*ivQsC*4BO%jeWa2ZZcnL1$TAya@^)!`!F%`&%M2VTWiki zyS!ErK9nYPwUh}$SyT8Xq+=Fa`J|bNjw*gD8a)O!(m1R~zFpAtrz@ zK-aBv-lau^{>SKdFu8W{W<=zoG8!c-xK}0DEwgN!uooz@mgQYpyH^&dHzB?tn!1_8 zw6pXmr)4%mb(jyXBD%|8l6N+g z>t*|-;=W~f>z!36;)JlXxZgYy+@)M zqO9WJFy-SI?W8}>R)p}zXGQ>aWV0qTB#afiLlXZF@xP}9(n3Qg zt+xouRz9uNZ6OhcWoDtGOJ-RW<6Po7O_P7$qFqzPS9t^gdr=JP-b1A&JrgTk8SD58 zqmv0I=ynu|y)x{0dis$Gwz1#g{#r|oIAJA~Pg#y&E5egv2 z8JRE|D2gTv&#HlsJySJy{-oNFx1EYsdJdbrX$5I(s)76LJ&YH+Q3PZCtM0$UD26RL zo*kqBf{dPHQnmL-MFyG|kxAr;g_5CMp%`^x?zD^e~vo4ZPqM9$-{2?_uHH20xA%u@VH zp7LH8696}XKH~VYy9VANk6%liqu(q*>o!kWt-N)J~`KQ!B|DmNSa6Scnok>6`6~+4mx3ajI6uv}q#QMF|Brq(b zd};YdK&T0diVVzK`pt77UYh~oj{l$J*R9rV2HQk!63~VP`L4B?eSg}2?!)9oHwnN( zXlc?GbrxmPpPu)y^q+3M_gH~|jG0^UajvNqRTqt1NWFWI@TR%j12$L*mGi+1r!4=e zr%-#_!tnijMa>>7pZo3k^TmIDE-O~RibDVf$IP#1?G^9##<(eRyJO->0A;~iqg~^% zC;aDTEiCTsDM}aWug8N^AZ<3gC~Tz+E=b~Ha{VYzOc5&vS&#;`sfu~<{`oV%+PMks zz<2t}YFDsm=~9M1(r|?bD$bL$pIrS8g3R;B$!9f=XS3eC#nxP>0X#pAZ|iaumpwgv zI!~fml*v4y}_(b2e;grnYUjY^{G6&C^z*lx=Zd`IW*akfW7rwl3?6T zXt+rONM-z!nPvCeNo~xMK=iREYS*8+uz5Pa;Ft*!ftN`?BH&=x>l(yr6aT|*$}M20yAbb zQoJPl%LQLf@=u`-b?C1^Ruls&LUbYPnHq>I7CFO*6{`L ztYSN&K;@9swpyH8vEP(6dD~z)GmlUD;iOe<)qt6hUi%*!tZ=FbO>JEJY|UN>#SClh zdi#Kt`=2)#^I?&R?z#YndD-8m6ptKdIyAP1&bs5PyCTGe>0p#-L8GU87EXpZGsNdw zZyR>PNMXE2Z=oTVIPYrd#A(DJX5x@B2~D~XkIojVd`eN|npW^X2=PX$xC^$r@}tP> zkaxPJ?96%JufXr#FWchhbwuWqwQ*svDEM4msezQRR@qByH-=-g3{qd+*c>BBSQQjW>A<#IuBj(ir#C3sq5*j--hMRi(Q^!Q~yk8e&nL<*9Y~r8BjolCp0rZr9U% z>edddj~>Vf!EufgpnsJ#;={IpH`bAbX?=tJb+mvKUTbF>f&&I!* z8>eezbYc4Tpt>vNDI-y=Xp`&$?n{G3&GS)Mzt6-WZywe%x>PeF9;c7P7hT3x6awF4 z>t;A=P5qTH(d&HKbyFV1v#QqP&(OCr8I&zXM=?~`S%Y;a>H>W~b!8Rf*t}BFQWl!R z!6}CE^jn){^Ue+zzQj{pWWG|Jfy93&!G+@cmUaej{sk-r|3QBgE}^a3Im(}Tv7SUs z!dPhkMUO*^FVpvNuze@#K*j^uk5VZDZ6BDBK==dD=Kv|%!w^6)0Zj_%al$Bp4Cx4Z zK=L^oG9_q*5%h=uBOdXk1`$bUS`q+lSaZqb1Y;)$+U|`Mf^1o!;~UG;4L*?ufUx&k zmog?tK$%f=eEjHeN2!;@e*phwJ zbe zdu&z*PFN+fiwv>Y^_!J+4v8E+L_BI9{rv7zaB!NTE?vCiKyi86Dzo3$U!700*?J?<5KG2S$;eT*EhDi{~+?mKPyIr@La7~sP2QQR9Bfk=qtwo+-CdT+m0vX zi>1}JRM;;vzi+e5vGoyK?E3z|*}{TLn>fA71FIJ|8<`oA`@8RxJ2Z|(qqsSjJFDJx z(+Utk4>s_C5zYpJ3S?n{68(|MnuZaogce~sG3*xs8KPI^PBiDTvYl7?@_)$k0~mXn zAXP>_8r2ZcFC@%xXsIfmVpKS)%mTj}mE)Z|EB}0@L$%Cc6tmtGk;tXwSRvmy5gTGw zJQA5$_1c@9Ur0ZTK+X@oic@6>MbL9-dk<%pNWf zJ-bZ-wv}0zdUG$FR=||dc$)%m2iFAG>g(V5LgFRv78sjZjDgfQ#hCtnJUSk(b0m-) z6R*`af=5?drt95@bZHGk67#r^t=6Mhx06W#;jSvQuG>g6xUi$;*^rn~i+Ww~IaECF z9?~ve{DA&;LU^D(1)pJq&=D&4;Bt#JfN6x#2We1w;E4P(r+YI70cet;ge%n&5a2zS zWhk>HR_B3x1}nsX+A%0905<>!UK2JYl7K08B?H=Cc~j&*zr6F(C~_6Mro~*!HBt#& zBJysmHLxfF_R>k@c%>poV;axA>wr5itzr_;lU${CvQ2C9;tJmT*t-afbcA>g8QYg)jPL4Mackl zic*+!lVH*3aR68tyh*UC8VB~%e)=+8mr6oQ@yZ3ATh^?5FWk#9Pu$`nZ%Z&A{^7H3 z%n)GZ8_0-kbK_?54~DQL}ECEgV)O59s82=&{F1bow7l8N?+T?Itii}-=Sr0q4*LH(x|^pl#bHQHb;8IG5>0x5}`kB zbmWt!SmEBnhfD(#)y;a;>x?&}uFF2wl2*Q|g~_^uDL?Hr#Ep&_k;nHC!aBp5c4>ne zi9%fe78brQM(#P}FaH;eTR|E0BaFlp$NGv*o$=|g`&Xm6z3Z^@4l5vX&u~il?V)uA zXe>stn$38G?w!tHiW77xnP{;ztv@O%cYoi8JDitt&WBFuRmh5whqP#7?cblD zzVyC26x{#UF;7z(fz>(_XsObzOz6T*f4SCUJ<*8onsZL*V)|C)_xwlW+?EAVyMvIu z$18C<|5!UK7QIcjyLi6OZ+%PEoxlArp4@W0d#?s+H6({`TwyoV4v6z3Ao4ir|rw>tZA1wXz39fiud&f@3WZ5Pn|=o}cnX7K_%eIx(V#K(=u z0K#v`>}6-{*@Et`$Mx~+39wye$gx9t73@8M-qm04$LsE60HCS)&u$t+ekl`$lWcUQ z0ULUGhzwB$knQ=+*3Z=fly9a$Ps+SB6W#lk6j1k4#z|sq!A;!$;#&ZiBeY-g)jw{c z2b@;9(%ksxWxULBCl5Gg9?|)aFh%p%*Vhjb+t-?o{11rezi25Bzk}-2(=QjfKF*XH z)fXIxc0~PphGfsx3l=cK%jDf({BKBYN3C8*Eo3_E9Jc&<>l9@-zu|PDqVn&2JXoCG zpy|(o>tSFV5u-NQe!kzaxVe2!b99N$$1tV_L^|<@1@n*g5q4jV8XVuUk27{ez`ccL5W;G^fe<`)759KputV<`+ zbMZLo?A^SvuSd1QcJ)Z}+a2v$m(Y|)n+cCbxiU$2y(TvD%+_eD2)ul@e*#}782%Cx0Y9Gl!r*Jyu7ts%IU>)#_LlQ9sTkyK{`v zXLR{vwU3(^y{Y=*9mSG9Y*{%DXUgGD5G}G<+j{+t53$$!82W@Rds$%U*LhDSBg)a5 z)LbB%qip@y%lu;U@AgM8u_gO>tBV5V&1O8+-0zC>Qk4AUUZZ@ai`&RGrQTDW7APSS zo0;(lE3!x;eu|}?@)rq zBWgv*uYX}JW?5@zlb(0=-PM16WJPv$Z4{y~-+pq;O6UxO>4dnxlamXKeL{?3Hz)3S z#l30BBiQgj|9HgUz2l*8(z5jO%eZ1dy*EN!x)UvhIdy)#Vu4nTx;`#QB}1d}-$zbl zmz8~MpE<^XazUHX>1iL#*=*0wPkkDquJw@@+4YVmU>?Z&teF%?r~Ye&5h>Wssnkv% zgC?bsOGj5PQz+!Y)u;Jm!PvXPj1=^rmLV}DwfZF`Rg9K03hYSKT2?=%!e(Y#gINxW z!Mxd6j+Y7${>B|ScyF0jDY%J2E`kEEs}9o}5-8l8WgjaC4G1sZK^7=b=En7L`MKWV z1%UTi!Nb?A?b4x}Z0mxhWRPN7l7$%b#?lofYe$`FNZWlXELX_1)-f$EsI`opL{c_} z#VH1j6LX&a@%6w=&p0!SyBX-&`2B#cgavj~TY_?MHhcWGFO?Cg{)-B`ShyF1*Fcy% zF#^}25!<1l+TyRcG)UF`$nYJ7d$GB-n+-aGz!QyO74hwLyS=bHd;xgE0wj~e{IkxP z)OJ#b(gMaAfQFj{eP@TGe8kyDR7L_dFi3^n|KS)AYRU`4ztIE2St7RYLYHZA;8}qj z8GhMp9ecN#{ff^N1>kvaxTvc4w(LzQ8o=;YggC-P?&g^5@mF>TFw2NkEyTXd?QTE} z3S0psmB?}{Cn`cmmlyrK%)y?EJC$OXITkg$&3i-I$|G!c~E6*-*fwn=G`3Zmy8UC*pghPY% zH3;}$%_J#@q#L>dqx{h8HTp(FpA6p*&IhM{*5#b6#cL!`4WHaAxDUz~jG*__7=~nI z3-{B&Z;BA1D_vUh#z506Xq%g9RAx*=j zJGph~*wCkDU{##{( - - - """, - "class": "", - }, - ], - # Toc options -} - - -# -- Options for Markdown files ---------------------------------------------- -# - -myst_enable_extensions = [ - "colon_fence", - "deflist", -] -myst_heading_anchors = 3 - -# -- Custom css -html_css_files = [ - "css/custom.css", -] - -html_static_path = ["_static"] - -add_module_names = False # Class names without full module path - -# 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'] - -copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " -copybutton_prompt_is_regexp = True diff --git a/doc/content/encodings/index.md b/doc/content/encodings/index.md deleted file mode 100644 index 2b8e2f8..0000000 --- a/doc/content/encodings/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# ASP Encodings - -Descriptions of ASP encodings. - -```{toctree} -instance.md -``` diff --git a/doc/content/encodings/instance.md b/doc/content/encodings/instance.md deleted file mode 100644 index f325dd4..0000000 --- a/doc/content/encodings/instance.md +++ /dev/null @@ -1,32 +0,0 @@ -# Instance - -## Constants -```{list-table} -:header-rows: 1 -:widths: 25 100 - -* - Name - - Description -* - `horizon` - - The description of a constant. -``` - -## Predicates - -### `predicate(X,Y)` - -Description - -```{admonition} Example -```prolog -predicate(1,2). -``` - -### `another_predicate(X)` - -Description - -```{admonition} Example -```prolog -another_predicate(1). -``` diff --git a/doc/content/installation.md b/doc/content/installation.md deleted file mode 100644 index d0a73f0..0000000 --- a/doc/content/installation.md +++ /dev/null @@ -1,41 +0,0 @@ -# Installation - -fillname requires Python 3.8+. We recommend version 3.10. - -You can check a successful installation by running - -```console -$ fillname -h -``` - -## Installing with pip - - -The python fillname package can be found [here](https://fillname.org/). - -```console -$ pip install fillname -``` - -## Development - -### Installing from source - -The project is hosted on [github](https://fillname.org/) and can -also be installed from source. - -```{warning} -We recommend this only for development purposes. -``` - -```{note} -The `setuptools` package is required to run the commands below. -``` - -Execute the following command in the top level fillname directory: - -```console -$ git clone https://fillname.org/ -$ cd fillname -$ pip install -e .[all] -``` diff --git a/doc/content/quickstart.md b/doc/content/quickstart.md deleted file mode 100644 index 91841a9..0000000 --- a/doc/content/quickstart.md +++ /dev/null @@ -1,11 +0,0 @@ -# Quick start - -A simple explanation on how to use the system. - -```console -$ fillname -h -``` - -```{tip} -Tips on how to use the system. -``` diff --git a/doc/index.md b/doc/index.md deleted file mode 100644 index cbd580e..0000000 --- a/doc/index.md +++ /dev/null @@ -1,9 +0,0 @@ -# fillname - -An example project template. - -```{toctree} -content/installation.md -content/quickstart.md -content/encodings/index.md -``` diff --git a/docs/_custom/css/extra.css b/docs/_custom/css/extra.css new file mode 100644 index 0000000..103c289 --- /dev/null +++ b/docs/_custom/css/extra.css @@ -0,0 +1,25 @@ +:root { + --md-primary-fg-color: #5089be; +} + +.md-grid { + max-width: 1350px; +} + +.md-header__title { + font-size: 1.2rem; + height: 2.5rem; + line-height: 2.5rem; + margin-left: 0 !important; +} + +.md-header__button.md-logo { + /* margin-left: 30; */ + padding-bottom: 0.8rem; +} + +.md-header__button.md-logo img, +.md-header__button.md-logo svg { + height: 1.5rem; + width: 1.5rem; +} diff --git a/docs/_custom/css/mkdoclingo.css b/docs/_custom/css/mkdoclingo.css new file mode 100644 index 0000000..dce2431 --- /dev/null +++ b/docs/_custom/css/mkdoclingo.css @@ -0,0 +1,49 @@ +code.doc-clingo-symbol-encoding::after { + content: "ASP"; + color: var(--md-primary-fg-color); +} + + +code.doc-clingo-symbol-predicate::after { + content: "predicate"; + color: #ca91bf +} + + +:root { + --md-admonition-icon--asp-doc: url('data:image/svg+xml;charset=utf-8,'); + --md-admonition-icon--asp-doc-ref: url('data:image/svg+xml;charset=utf-8,') +} + +.md-typeset .admonition.asp-doc, +.md-typeset details.asp-doc { + border-color: var(--md-primary-fg-color); +} + +.md-typeset .admonition.asp-doc-ref, +.md-typeset details.asp-doc-ref { + border-color: #ca91bf; +} + +.md-typeset .asp-doc>.admonition-title, +.md-typeset .asp-doc>summary { + background-color: #1669B810; +} + +.md-typeset .asp-doc-ref>.admonition-title, +.md-typeset .asp-doc-ref>summary { + background-color: #ca91bf10; +} + +.md-typeset .asp-doc>.admonition-title::before, +.md-typeset .asp-doc>summary::before { + background-color: var(--md-primary-fg-color); + -webkit-mask-image: var(--md-admonition-icon--asp-doc); + mask-image: var(--md-admonition-icon--asp-doc); +} + +.md-typeset .asp-doc-ref>summary::before { + background-color: #ca91bf; + -webkit-mask-image: var(--md-admonition-icon--asp-doc-ref); + mask-image: var(--md-admonition-icon--asp-doc-ref); +} diff --git a/docs/_custom/css/mkdocstrings.css b/docs/_custom/css/mkdocstrings.css new file mode 100644 index 0000000..ec3f314 --- /dev/null +++ b/docs/_custom/css/mkdocstrings.css @@ -0,0 +1,50 @@ +code.doc-section-title { + font-weight: bold; +} + +code.doc-symbol-parameter::after { + content: "P"; +} + +code.doc-symbol-attribute::after { + content: "A"; +} + +code.doc-symbol-function::after { + content: "F"; +} + +code.doc-symbol-method::after { + content: "M"; +} + +code.doc-symbol-class::after { + content: "C"; +} + +code.doc-symbol-module::after { + content: "M"; +} + +:root { + --doc-symbol-parameter-fg-color: #df50af; + --doc-symbol-attribute-fg-color: #0079ff; + --doc-symbol-function-fg-color: #00dfa2; + --doc-symbol-method-fg-color: #00dfa2; + --doc-symbol-class-fg-color: #d1b619; + --doc-symbol-module-fg-color: #ff0060; + + --doc-symbol-parameter-bg-color: #df50af1a; + --doc-symbol-attribute-bg-color: #0079ff1a; + --doc-symbol-function-bg-color: #00dfa21a; + --doc-symbol-method-bg-color: #00dfa21a; + --doc-symbol-class-bg-color: #d1b6191a; + --doc-symbol-module-bg-color: #ff00601a; +} + + +.cssClass>rect { + fill: #ff0000; + stroke: #ffff00; + stroke-width: 4px; +} diff --git a/docs/_custom/javascripts/mathjax.js b/docs/_custom/javascripts/mathjax.js new file mode 100644 index 0000000..5b34852 --- /dev/null +++ b/docs/_custom/javascripts/mathjax.js @@ -0,0 +1,19 @@ +window.MathJax = { + tex: { + inlineMath: [["\\(", "\\)"]], + displayMath: [["\\[", "\\]"]], + processEscapes: true, + processEnvironments: true + }, + options: { + ignoreHtmlClass: ".*|", + processHtmlClass: "arithmatex" + } +}; + +document$.subscribe(() => { + MathJax.startup.output.clearCache() + MathJax.typesetClear() + MathJax.texReset() + MathJax.typesetPromise() +}) diff --git a/docs/_custom/overrides/.icons/potassco-full-logo.svg b/docs/_custom/overrides/.icons/potassco-full-logo.svg new file mode 100644 index 0000000..b5c199c --- /dev/null +++ b/docs/_custom/overrides/.icons/potassco-full-logo.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/_custom/overrides/.icons/potassco-logo.svg b/docs/_custom/overrides/.icons/potassco-logo.svg new file mode 100644 index 0000000..fde2a4a --- /dev/null +++ b/docs/_custom/overrides/.icons/potassco-logo.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/_custom/overrides/partials/logo.html b/docs/_custom/overrides/partials/logo.html new file mode 100644 index 0000000..1ea5a40 --- /dev/null +++ b/docs/_custom/overrides/partials/logo.html @@ -0,0 +1,29 @@ + + + +{% if config.theme.logo %} +logo +{% else %} +{% set icon = config.theme.icon.logo or "material/library" %} +{% include ".icons/" ~ icon ~ ".svg" %} +{% endif %} diff --git a/docs/assets/images/potassco-full-logo.svg b/docs/assets/images/potassco-full-logo.svg new file mode 100644 index 0000000..b5c199c --- /dev/null +++ b/docs/assets/images/potassco-full-logo.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/images/potassco-logo-dark.svg b/docs/assets/images/potassco-logo-dark.svg new file mode 100644 index 0000000..e6706af --- /dev/null +++ b/docs/assets/images/potassco-logo-dark.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/assets/images/potassco-logo.svg b/docs/assets/images/potassco-logo.svg new file mode 100644 index 0000000..fde2a4a --- /dev/null +++ b/docs/assets/images/potassco-logo.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/community/CHANGES.md b/docs/community/CHANGES.md new file mode 120000 index 0000000..8980b4a --- /dev/null +++ b/docs/community/CHANGES.md @@ -0,0 +1 @@ +../../CHANGES.md \ No newline at end of file diff --git a/docs/community/CONTRIBUTING.md b/docs/community/CONTRIBUTING.md new file mode 120000 index 0000000..f939e75 --- /dev/null +++ b/docs/community/CONTRIBUTING.md @@ -0,0 +1 @@ +../../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/community/DEPLOYMENT.md b/docs/community/DEPLOYMENT.md new file mode 120000 index 0000000..efafc4c --- /dev/null +++ b/docs/community/DEPLOYMENT.md @@ -0,0 +1 @@ +../../DEPLOYMENT.md \ No newline at end of file diff --git a/docs/community/DEVELOPMENT.md b/docs/community/DEVELOPMENT.md new file mode 120000 index 0000000..62bb95a --- /dev/null +++ b/docs/community/DEVELOPMENT.md @@ -0,0 +1 @@ +../../DEVELOPMENT.md \ No newline at end of file diff --git a/docs/community/help.md b/docs/community/help.md new file mode 100644 index 0000000..d83119a --- /dev/null +++ b/docs/community/help.md @@ -0,0 +1,44 @@ +______________________________________________________________________ + +## icon: material/help-circle + +# Help + +## First steps + +!!! tip "Search bar" Use the search bar from this documentation page to find +what you are looking for. + +!!! tip "Look at the examples" The examples tab has might give you some insides +into how to use the tool. + +!!! tip "Mailing list" Our [mailing list][mailing_list] might have some +information about your issue. Search for questions made by previous users of +the potassco tools. You can also [subscribe] to this list to get updates and +join the community. + +## Further help + +!!! question "Open an Issue" + +``` +Open an [issue][new_issue] describing your problem. + +!!! warning + To avoid duplicating issues, please search our [issue tracker][issues] and our + [mailing list][mailing_list] before filing a new issue. +``` + +!!! question "Reach out in the mailing list" + +``` +Send an email to the list with your issue. +``` + +## General ASP support + +- Take a look at the [support page][support_page] of Potassco. + +[mailing_list]: https://sourceforge.net/p/potassco/mailman/potassco-users/ +[subscribe]: https://sourceforge.net/projects/potassco/lists/potassco-users/ +[support_page]: https://potassco.org/support/ diff --git a/docs/community/index.md b/docs/community/index.md new file mode 100644 index 0000000..4e3383d --- /dev/null +++ b/docs/community/index.md @@ -0,0 +1,32 @@ +# Community + +Welcome to the **Community** hub! 🚀 + +This is the central place for everything related to contributing, staying +up-to-date, and engaging with our project. Whether you’re here to collaborate, +explore the latest changes, or find support, we’ve got you covered. + +## What’s Inside + +- **Changelog:** Stay informed about the latest updates and improvements. +- **Contributing:** Learn how to get involved and make an impact on the + project. +- **Development:** Dive into the technical details of how our system works. +- **Deployment:** Get guidance on setting up and deploying the system in + various environments. +- **Help:** Access resources to get answers to your questions. + +## How You Can Contribute + +1. **Report Issues:** Found a bug? Let us know! +1. **Share Ideas:** Help us shape the future by suggesting features. +1. **Collaborate:** Submit pull requests and contribute code. + +Your participation keeps our project thriving. Thank you for being part of our +community! + +!!! info + +``` +*fillanme* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) +``` diff --git a/docs/examples/index.md b/docs/examples/index.md new file mode 100644 index 0000000..6cb6c1a --- /dev/null +++ b/docs/examples/index.md @@ -0,0 +1,18 @@ +# Examples + +Welcome to the **Examples** section of our documentation! 🎉 + +Here, you'll find a comprehensive set of practical examples designed to help +you get the most out of our system. Whether you're a first-time user or an +experienced pro, these guides will walk you through common use cases and +provide step-by-step instructions. + +## How to Use This Section + +Each example includes: + +1. **Instructions** to run the example. +1. **Code snippets** to demonstrate implementation. +1. **Helpful visuals** to illustrate key concepts. + +Dive in and start exploring! diff --git a/docs/getting_started.md b/docs/getting_started.md new file mode 100644 index 0000000..3c5e733 --- /dev/null +++ b/docs/getting_started.md @@ -0,0 +1,35 @@ +# Getting started + +## Installation + +=== "Pip" + +```` +```console +pip install fillname +``` +```` + +=== "Development mode" + +```` +```console +git clone https://github.com/potassco/fillname.git/ +cd fillname +pip install -e .[all] +``` + +!!! warning + + Use only for development purposes +```` + +## Usage + +### Command line interface + +Details about the command line usage can be found with: + +```console +fillname -h +``` diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8206b81 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +______________________________________________________________________ + +``` +title: Home +hide: + - navigation + - toc +``` + +______________________________________________________________________ + +# fillname + +*fillname* fill description + +!!! info + +``` +*fillname* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) +``` diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md new file mode 100644 index 0000000..f7110fb --- /dev/null +++ b/docs/reference/api/index.md @@ -0,0 +1,5 @@ +______________________________________________________________________ + +## icon: material/book-open-variant + +# API diff --git a/docs/reference/encodings/index.md b/docs/reference/encodings/index.md new file mode 100644 index 0000000..a1871b0 --- /dev/null +++ b/docs/reference/encodings/index.md @@ -0,0 +1,5 @@ +______________________________________________________________________ + +## icon: material/file-code + +# Encodings diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000..d21c7fe --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,19 @@ +# Reference + +Welcome to the **Reference** section! 📚 + +This section contains detailed documentation and technical information about +the system. It’s designed for those who want to explore the inner workings, +learn about specific components, or access essential resources. + +## What’s Inside + +- **API Documentation:** Comprehensive details on general classes. +- **ASP Encodings:** Explore the encodings used in our system. +- **Problem Specifications:** Detailed description and definitions of the + problem. + + + +Use this section to find the information you need, whether you’re debugging, +extending functionality, or learning more about the system. diff --git a/docs/reference/problem/index.md b/docs/reference/problem/index.md new file mode 100644 index 0000000..a8aa1e9 --- /dev/null +++ b/docs/reference/problem/index.md @@ -0,0 +1,5 @@ +______________________________________________________________________ + +## icon: material/head-dots-horizontal + +# Problem specification diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..b35060c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,111 @@ +site_name: fillname +site_url: https://potassco.org/systems/fillname +site_description: +repo_name: potassco/fillname +repo_url: https://github.com/potassco/fillname +copyright: Copyright © 2024 Potassco + +extra_css: + - _custom/css/extra.css + - _custom/css/mkdocstrings.css + - _custom/css/mkdoclingo.css + +extra_javascript: + - _custom/javascripts/mathjax.js + - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js + +theme: + name: material + logo: assets/images/potassco-logo.svg + custom_dir: docs/_custom/overrides + favicon: assets/images/potassco-logo-dark.svg + features: + - header.autohide + - navigation.instant + - navigation.tracking + # - navigation.sections + - navigation.indexes + - content.code.annotate + # - toc.integrate + - toc.follow + - navigation.path + # - navigation.top + - navigation.tabs + - content.code.copy + - content.tooltips + # - navigation.instant.preview + # - navigation.expand + icon: + repo: fontawesome/brands/github + admonition: + quote: material/file-code-outline + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + primary: custom #, [red, pink, purple, deep, purple, indigo, blue, light blue, cyan, teal, green, light green, lime, yellow, amber, orange, deep orange, brown, grey, blue, grey, black, white] + accent: indigo # [red, pink, purple, deep, purple, indigo, blue, light, blue, cyan, teal, green, light, green, lime, yellow, amber, orange, deep orange] + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: custom #, [red, pink, purple, deep, purple, indigo, blue, light blue, cyan, teal, green, light green, lime, yellow, amber, orange, deep orange, brown, grey, blue, grey, black, white] + accent: indigo # [red, pink, purple, deep, purple, indigo, blue, light, blue, cyan, teal, green, light, green, lime, yellow, amber, orange, deep orange] + toggle: + icon: material/brightness-4 + name: Switch to light mode + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/potassco/fillname + - icon: potassco-logo + link: https://potassco.org + generator: false +markdown_extensions: + - admonition + - pymdownx.details + - pymdownx.keys + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format + - pymdownx.tabbed: + alternate_style: true + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + options: + custom_icons: + - _custom/overrides/.icons + - attr_list + - md_in_html + - pymdownx.blocks.caption + - pymdownx.snippets + - pymdownx.arithmatex: + generic: true + - toc: + permalink: true + - footnotes + +plugins: + - search + - autorefs + - mkdocstrings: + handlers: + python: + import: + - https://docs.python.org/3/objects.inv + options: + show_symbol_type_heading: true + show_symbol_type_toc: true + # show_root_toc_entry: false + # show_inherited_summary: true + show_inherited_detail: true + show_inherited_detail_toc: true + show_inherited_detail_tree: true + show_source: false diff --git a/noxfile.py b/noxfile.py index e6d8125..4ce270d 100644 --- a/noxfile.py +++ b/noxfile.py @@ -21,27 +21,10 @@ def doc(session): - clean: clean up the build folder - : build the given with the given """ - target = "html" - options = [] - open_doc = "open" in session.posargs - clean = "clean" in session.posargs - - if open_doc: - session.posargs.remove("open") - if clean: - session.posargs.remove("clean") - - if session.posargs: - target = session.posargs[0] - options = session.posargs[1:] session.install("-e", ".[doc]") - session.cd("doc") - if clean: - session.run("rm", "-rf", "_build") - session.run("sphinx-build", "-M", target, ".", "_build", *options) - if open_doc: - session.run("open", "_build/html/index.html") + session.run("open", "http://127.0.0.1:8000/systems/fillname/") + session.run("mkdocs", "serve") @nox.session diff --git a/pyproject.toml b/pyproject.toml index 17aec66..cb2a813 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,7 +19,7 @@ format = ["black", "isort", "autoflake"] lint_pylint = ["pylint"] typecheck = ["types-setuptools", "mypy"] test = ["coverage[toml]"] -doc = ["sphinx", "furo", "nbsphinx", "sphinx_copybutton", "myst-parser", "toml"] +doc = ["mkdocs", "mkdocs-material", "mkdocstrings[python]"] dev = ["fillname[test,typecheck,lint_pylint]"] [project.scripts] From 8217cb013d5e0aa73ea7864eea5a237001f7edcd Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 15:18:23 +0100 Subject: [PATCH 2/9] adjust doc target --- noxfile.py | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/noxfile.py b/noxfile.py index 4ce270d..9c64122 100644 --- a/noxfile.py +++ b/noxfile.py @@ -1,4 +1,5 @@ import os +import sys import nox @@ -17,14 +18,23 @@ def doc(session): Build the documentation. Accepts the following arguments: - - open: open documentation after build - - clean: clean up the build folder - - : build the given with the given + - serve: open documentation after build + - further arguments are passed to mkbuild """ + options = session.posargs[:] + open_doc = "serve" in options + if open_doc: + options.remove("serve") + session.install("-e", ".[doc]") - session.run("open", "http://127.0.0.1:8000/systems/fillname/") - session.run("mkdocs", "serve") + + if open_doc: + open_cmd = "xdg-open" if sys.platform == "linux" else "open" + session.run(open_cmd, "http://localhost:8000/systems/fillname/") + session.run("mkdocs", "serve", *options) + else: + session.run("mkdocs", "build", *options) @nox.session From c2db72bbd9af22df06d59d0a6c0293df6e36ad35 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 16:52:54 +0100 Subject: [PATCH 3/9] fix markdown files + add nav --- .gitignore | 1 + docs/community/help.md | 6 +++--- docs/index.md | 8 ++------ docs/reference/api/index.md | 7 ++++--- docs/reference/encodings/index.md | 6 +++--- docs/reference/problem/index.md | 6 +++--- mkdocs.yml | 18 ++++++++++++++++++ 7 files changed, 34 insertions(+), 18 deletions(-) diff --git a/.gitignore b/.gitignore index 59ddbcb..d4ac8b9 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,4 @@ build .coverage _build _autosummary +site diff --git a/docs/community/help.md b/docs/community/help.md index d83119a..4c98225 100644 --- a/docs/community/help.md +++ b/docs/community/help.md @@ -1,6 +1,6 @@ -______________________________________________________________________ - -## icon: material/help-circle +--- +icon: material/help-circle +--- # Help diff --git a/docs/index.md b/docs/index.md index 8206b81..5221cc5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,13 +1,9 @@ -______________________________________________________________________ - -``` +--- title: Home hide: - navigation - toc -``` - -______________________________________________________________________ +--- # fillname diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md index f7110fb..0f84315 100644 --- a/docs/reference/api/index.md +++ b/docs/reference/api/index.md @@ -1,5 +1,6 @@ -______________________________________________________________________ - -## icon: material/book-open-variant +--- +title: "API Reference" +icon: "material/book-open-variant" +--- # API diff --git a/docs/reference/encodings/index.md b/docs/reference/encodings/index.md index a1871b0..fb7f670 100644 --- a/docs/reference/encodings/index.md +++ b/docs/reference/encodings/index.md @@ -1,5 +1,5 @@ -______________________________________________________________________ - -## icon: material/file-code +--- +icon: material/file-code +--- # Encodings diff --git a/docs/reference/problem/index.md b/docs/reference/problem/index.md index a8aa1e9..685afb9 100644 --- a/docs/reference/problem/index.md +++ b/docs/reference/problem/index.md @@ -1,5 +1,5 @@ -______________________________________________________________________ - -## icon: material/head-dots-horizontal +--- +icon: material/head-dots-horizontal +--- # Problem specification diff --git a/mkdocs.yml b/mkdocs.yml index b35060c..0b3d5d9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -65,6 +65,7 @@ extra: - icon: potassco-logo link: https://potassco.org generator: false + markdown_extensions: - admonition - pymdownx.details @@ -109,3 +110,20 @@ plugins: show_inherited_detail_toc: true show_inherited_detail_tree: true show_source: false + +nav: + - Home: index.md + - Getting Started: getting_started.md + - Examples: examples/index.md + - Reference: + - reference/index.md + - Problem: reference/problem/index.md + - Encodings: reference/encodings/index.md + - API: reference/api/index.md + - Community: + - community/index.md + - Help: community/help.md + - Changes: community/CHANGES.md + - Contributing: community/CONTRIBUTING.md + - Development: community/DEVELOPMENT.md + - Deployment: community/DEPLOYMENT.md From e8211d36d3e97ef44627d6af8284500fda5a4eb9 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 17:24:47 +0100 Subject: [PATCH 4/9] generate some API docs --- docs/reference/api/index.md | 6 ++++++ mkdocs.yml | 3 +++ 2 files changed, 9 insertions(+) diff --git a/docs/reference/api/index.md b/docs/reference/api/index.md index 0f84315..bf6914f 100644 --- a/docs/reference/api/index.md +++ b/docs/reference/api/index.md @@ -4,3 +4,9 @@ icon: "material/book-open-variant" --- # API + +::: fillname + handler: python + options: + members: true + show_submodules: true diff --git a/mkdocs.yml b/mkdocs.yml index 0b3d5d9..b6507b3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -99,6 +99,7 @@ plugins: - mkdocstrings: handlers: python: + paths: [src] import: - https://docs.python.org/3/objects.inv options: @@ -109,6 +110,8 @@ plugins: show_inherited_detail: true show_inherited_detail_toc: true show_inherited_detail_tree: true + show_signature_annotations: true + signature_crossrefs: true show_source: false nav: From 58dc69f18d5e4cb0b69e81f5e21fb9a67ed0c40e Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 17:27:53 +0100 Subject: [PATCH 5/9] exclude doc folder from autoformat --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index dc1431c..9826ff8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,6 +30,6 @@ repos: hooks: - id: mdformat args: ["--wrap", "79"] - exclude: ^doc/ + exclude: ^docs/ additional_dependencies: - mdformat-gfm From 58022f9f9c48bbf77fe916feb03d2176c0199916 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 17:44:30 +0100 Subject: [PATCH 6/9] fix md files shredded by mdformat --- docs/community/help.md | 31 +++++++++++++++---------------- docs/community/index.md | 5 +---- docs/examples/index.md | 5 +++++ docs/getting_started.md | 10 +++++----- docs/index.md | 12 +++--------- 5 files changed, 29 insertions(+), 34 deletions(-) diff --git a/docs/community/help.md b/docs/community/help.md index 4c98225..dc9121b 100644 --- a/docs/community/help.md +++ b/docs/community/help.md @@ -6,34 +6,31 @@ icon: material/help-circle ## First steps -!!! tip "Search bar" Use the search bar from this documentation page to find -what you are looking for. +!!! tip + "Search bar" Use the search bar from this documentation page to find + what you are looking for. -!!! tip "Look at the examples" The examples tab has might give you some insides -into how to use the tool. +!!! tip + "Look at the examples" The examples tab has might give you some insides + into how to use the tool. -!!! tip "Mailing list" Our [mailing list][mailing_list] might have some -information about your issue. Search for questions made by previous users of -the potassco tools. You can also [subscribe] to this list to get updates and -join the community. +!!! tip + "Mailing list" Our [mailing list][mailing_list] might have some + information about your issue. Search for questions made by previous users of + the potassco tools. You can also [subscribe] to this list to get updates and + join the community. ## Further help !!! question "Open an Issue" - -``` -Open an [issue][new_issue] describing your problem. + Open an [issue][new_issue] describing your problem. !!! warning To avoid duplicating issues, please search our [issue tracker][issues] and our [mailing list][mailing_list] before filing a new issue. -``` !!! question "Reach out in the mailing list" - -``` -Send an email to the list with your issue. -``` + Send an email to the list with your issue. ## General ASP support @@ -42,3 +39,5 @@ Send an email to the list with your issue. [mailing_list]: https://sourceforge.net/p/potassco/mailman/potassco-users/ [subscribe]: https://sourceforge.net/projects/potassco/lists/potassco-users/ [support_page]: https://potassco.org/support/ +[new_issue]: https://github.com/potassco/fillname/issues/new +[issues]: https://github.com/potassco/fillname/issues diff --git a/docs/community/index.md b/docs/community/index.md index 4e3383d..d230d56 100644 --- a/docs/community/index.md +++ b/docs/community/index.md @@ -26,7 +26,4 @@ Your participation keeps our project thriving. Thank you for being part of our community! !!! info - -``` -*fillanme* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) -``` + *fillname* is part of the [Potassco](https://potassco.org) suite. diff --git a/docs/examples/index.md b/docs/examples/index.md index 6cb6c1a..bff9d10 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,3 +1,8 @@ +--- +hide: + - navigation +--- + # Examples Welcome to the **Examples** section of our documentation! 🎉 diff --git a/docs/getting_started.md b/docs/getting_started.md index 3c5e733..cf57665 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,18 +1,20 @@ +--- +hide: + - navigation +--- + # Getting started ## Installation === "Pip" -```` ```console pip install fillname ``` -```` === "Development mode" -```` ```console git clone https://github.com/potassco/fillname.git/ cd fillname @@ -20,9 +22,7 @@ pip install -e .[all] ``` !!! warning - Use only for development purposes -```` ## Usage diff --git a/docs/index.md b/docs/index.md index 5221cc5..2644602 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,16 +1,10 @@ --- -title: Home hide: - - navigation - - toc + - navigation + - toc --- # fillname -*fillname* fill description - !!! info - -``` -*fillname* is part of the [Potassco] suit (which is the home of *clingo* and the other ASP tools) -``` + *fillname* is part of the [Potassco](https://potassco.org) suite. From f90aa94b30829d00dd2ccda5875e6d63b8f8f136 Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Wed, 4 Dec 2024 20:24:42 +0100 Subject: [PATCH 7/9] adjust init.py script --- init.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/init.py b/init.py index 3e14478..8472cad 100755 --- a/init.py +++ b/init.py @@ -75,11 +75,13 @@ def replace(filepath): with open(filepath, "w", encoding="utf-8") as hnd: hnd.write(content) - dirs = [os.path.join("src", "fillname"), "tests", "doc"] + dirs = [os.path.join("src", "fillname"), "tests", "docs"] files = [ ".pre-commit-config.yaml", + "mkdocs.yml", "noxfile.py", "pyproject.toml", + "CHANGES.md", "CONTRIBUTING.md", "DEPLOYMENT.md", "DEVELOPMENT.md", From 4b38c48954a9df349e8bf4353229afaf5bbff0ed Mon Sep 17 00:00:00 2001 From: Susana Hahn Date: Wed, 4 Dec 2024 17:33:29 -0600 Subject: [PATCH 8/9] Added serve to readme and changed color --- README.md | 2 +- docs/_custom/css/extra.css | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc38be0..f4605e6 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ fillname -h To generate and open the documentation, run ```bash -nox -s doc +nox -s doc -- serve ``` Instructions to install and use `nox` can be found in diff --git a/docs/_custom/css/extra.css b/docs/_custom/css/extra.css index 103c289..fe4b940 100644 --- a/docs/_custom/css/extra.css +++ b/docs/_custom/css/extra.css @@ -1,5 +1,5 @@ :root { - --md-primary-fg-color: #5089be; + --md-primary-fg-color: #6495ED; } .md-grid { From 0fbd3c545745ca8e8fdf82933a9ee0468e090d6f Mon Sep 17 00:00:00 2001 From: Roland Kaminski Date: Thu, 5 Dec 2024 09:24:34 +0100 Subject: [PATCH 9/9] tweak color of header --- docs/_custom/css/extra.css | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/_custom/css/extra.css b/docs/_custom/css/extra.css index fe4b940..b2264f2 100644 --- a/docs/_custom/css/extra.css +++ b/docs/_custom/css/extra.css @@ -2,6 +2,11 @@ --md-primary-fg-color: #6495ED; } +[data-md-color-scheme="slate"] .md-header, +[data-md-color-scheme="slate"] .md-tabs { + --md-primary-fg-color: #253758; +} + .md-grid { max-width: 1350px; }