From 6562410272f7ada6869343cc6d8c900ca4e17ef3 Mon Sep 17 00:00:00 2001 From: Jan Kaliszewski Date: Fri, 3 Dec 2021 04:56:07 +0100 Subject: [PATCH] [docs] New configuration of docs generation --- .n6-version | 2 +- .readthedocs.yml | 15 +++++++++++++-- docs/n6_logo.png | 1 + docs/requirements.txt | 3 +++ mkdocs.yml | 17 ++++++++++++++++- n6_logo.png | Bin 0 -> 7689 bytes 6 files changed, 34 insertions(+), 4 deletions(-) create mode 120000 docs/n6_logo.png create mode 100644 docs/requirements.txt create mode 100644 n6_logo.png diff --git a/.n6-version b/.n6-version index 4a36342..4564266 100644 --- a/.n6-version +++ b/.n6-version @@ -1 +1 @@ -3.0.0 +3.0.1a1 diff --git a/.readthedocs.yml b/.readthedocs.yml index 5ab4f3a..864c667 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,4 +1,15 @@ version: 2 + +build: + os: "ubuntu-20.04" + tools: + python: "3.9" + mkdocs: - configuration: mkdocs.yml - fail_on_warning: false + configuration: mkdocs.yml + fail_on_warning: false + +python: + install: + - requirements: docs/requirements.txt + diff --git a/docs/n6_logo.png b/docs/n6_logo.png new file mode 120000 index 0000000..be08a0f --- /dev/null +++ b/docs/n6_logo.png @@ -0,0 +1 @@ +../n6_logo.png \ No newline at end of file diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..849d812 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +mkdocs==1.2.3 +mkdocs-material==8.0.3 + diff --git a/mkdocs.yml b/mkdocs.yml index cf9f5bd..2af10a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,21 @@ nav: - API: - Stream API: guides/api/streamapi.md -theme: readthedocs +theme: + name: material + palette: + scheme: default + primary: white + accent: deep purple + logo: n6_logo.png + features: + - navigation.indexes + - navigation.sections + - navigation.top markdown_extensions: + - admonition - smarty + - toc: + title: "This document's sections" + permalink: true + toc_depth: 2 diff --git a/n6_logo.png b/n6_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..f5f6e736d443c2604acc6a24988d57d96a037e38 GIT binary patch literal 7689 zcmeHLXIPWjwoV9y-UTUwp-7WJ2!Rwqf=HDTI!FykfFL0;2_zzDL{z{LMM1y;#gU?* zfI<{$21TlX4GT4lC4j%OXmn~MIhF)r?xT?)BsMt`0ALTy z1O%NOH<0-nrBovvx+4P3d5CU09Qa%CSlVRT=${~)%#!ff!;*J_(b?QOE{tsYx*KL#w99K41a?Z3VHz$fKpbFDhJrFf?F z={-#QQfXfC*$=z#wJgb3E^pE}CR{fqG_IC>KYjW<{3`W|o|{hKKv@Xcw)Gqftc#uy zDQffpc=lDa0^G4|87pYy167v z)2mp*Sy5U1F==5)GDYX(v)jAolBJ9>un)XJ5U4G0-`PO@9?N}Q?-<5)edWjff*N(N zHXn_IW}q&*1==@c7Fq_ApSv|sMs9r31pC)S^mm-Qo*u6*`_!v0{Oi~fCgyGC?(I&? z*aJmJ{qyI%b!GL(^MKcb73HEF0WyUeH3nC-kE58Gf$vlsQsBk9qK;>Dz{1n+`Nr1O zU(|1J9NKYhRqR%hqX~*RdMKDSx!rcwacDc%&3f=^z+KypTNl+Wlw)nWcgY7C^*z?X zbJJiu8`G7qg7A>g^L|P#dfeGNW+ENmu75pf<)3)?3@wD zb4c^*4{lsh8Iq&EjMTWV{6O{^2FiF{9dKh_Q<*EqsWzyUe|r}RMc3K)RuP|-L8?TyAN|xTtD5$nKh>= znYM%v>bKn8qUyI_afaG*D%A9mNz3{Bi3@+z^9a#s+kLhO&N%Ib=}DH>WYbi!ld z3P+tQK_CjXHGL%LhPWRG`*K?e1*)UBbE>nGlppLQ$Kb1T87ZgC$6qFRFqoIL_G|l= z8AcGeKd}rw9yh=0-S?sxsC4~)=H?wk%zdUy9eX>be=VatYU~><^}**(J~2)i=HHag znA=cft;Obe$FeO`?&XQnn<4Y3!ori>3!kT!l&~@FjL2@0tnt{x(uuLjD=tM{Wg~YL^mOtJJ1;XuUD!~jIz8Dx zi&8~V-;z_xPinz&O`1ADd83=TV`U(@oL#}1IUj@;NA(RHg-IGIu0mUkPXta0^@ZlN z*eQ7NG%MbrtSkD^IK6lMPiqt{ibY=Bw*U;jCkiJ{bVfsUFQuM-6rm#ahM#hV!}o z6RsLWx$#)nT@3K;v=KGvD)`Zt>(Vx=fLS91wz@RMa`D`5dvV-0Y#y(t5We`cH=Q%J zZ6w5tRS}9P8}PCHMQy7q;H7QuzG1Jc+!!U-;*kK&$)(<{D>5D{fnU1QZ(41g*R~OI zC||^;4WD!p!;YOSl50bUJbJhpvrV;@?}}S+=GOIuOw}~J!?a*pSn84Zgk0?)~K!_ zE`fOm(2q2#`}lOL@r=3HF_Fqq(P{kSdAFiu%SX8_iQ!72E&qa#fuBF;CFUWL6r(r0 zE%Xn6tiOHt!d#_)%~4apW5#K}vZCsa$N3co^iC|M=!(IO5}h*eYA;q_u$WxmsCrqy zsrJ!Py2up=dC6S&Dt{%ep8fcn@rzGDHlee_iZ3Jz;W11j1H4yxnaqH6{3+BxPJn02 z=VO!ZHD}(2wl&Ec&74RnuiD#3ADct?Z$EF8FCiZ5ep3v5UgRgoEOeJIX~#)B?Z(*c zx2MY|+$BE3KUjXbGKiCHd+R&Q)X_;c@}b_G@_ks?e>gWE39N*BJ2Z8<7TZRt&E9%> zhWg3Nd@upjoblQs5_LKx!dmjaXqgTJ5_do-LK%eO-FXt@F$$%e?^2 zfF}>T=L*uq!Y-&gJl}DxOY`s)uXJmLV|GBS!>TV+|h=RiPqZw7H%*%njI;c?373+ zc_+I25EAzg&_r#U?GjdOi~xW_V&WleN^Beh!?xC5$HfTl*TkmUkaZL09&7CYHyp%{ zN+&@OCI}N4)SgXFfNO7;fLPIqkr=O?4&NaJPuAMeOePIuYRY1K=xlOndHbn$@)uf zYnt_PeoRE*{s-<~tbeb4-B@7d=7!lxCB(0#=e*Nedo4bONF|VonDtv20zryE!(mWM zVgw9|AP~%siV+ZtU+Yr=z`9&e3&xI4!ZWFKA1XE0T6--e$eQPRdqb?g4T=+)A+XrD z*74taeg{74+tarx5KCTHK_KgGi@_7V1!3S5NW}F(0>5u6LNq=uiX@od-y7<8Ir%>f z7CO?>oQSkQL-8m}1QbC;BB3Z^LHp%y zYTe+6WkBHfO(s}g1gn+lAIsHu&emxBFaExd#eXq^0Q#RGe~aIL==z7Qzs11cGXAH# z{-Nt{G4QvH|LLy(H@YPLeBmL*33fp&!RySkW?={b08Ay@+2Ne+?0*073IG^nC1+VX z-NSCWALd=M+ejus&Qr{*&^Rpv6{D1a(|Rg#4U-rAS;S54^oEU&EnGgoJ)*zmexSdo zzpdN~U@wE=#mrJz&E2rOHIX)SlC`MGngd+)i#XSBCKFvx(R*cPRv4%RsuI)Y#7W@; zBF~!XJB!z9ge}g$|7g-xGjQPxW8re(ap3kW_F2_Zw?7!9umk;#Zxhc7|FXP~dU5+~ezJMSA4IRAeia;Vxa|&bt046$X2asK2lOPa^GM(M* zMPEyZiW_WDinV)7D4ut$a8r&4&cwyntsHlO&YFzs~4WWvadLmA2ab; z+_I)n<^p$*q&2U<^M&=3xzhu~l|jv))HD}}2h4|eksRP-vBbce~WTzO8Ev&nlkQEf2?Y?d05NP2z<_$kMb(y`1? z>0oe@c@*9`_!fP5%(BWnEBw-X!#BFEOB<3EepwkXTsEwo994&7``cLZ)fer7GV+<$ zRp6T{MfDu|@ztIK;nLNp{MOI5wY$sJQ5pfj2MFwa9Kans3rZXk+4^jD)it~+2z&ph zc`J~QtGP7J%vS@HFn`>muG#GfbGvAP&;xw-oVsfG!~i&0=BkGwFRo}K>KVY|u`*3( ztazZdaocWACNQVevk!^Dmb~=<`Meu$1R6C+;mA`+?0rNuhrZERUkiL$B5SS_vf!F;ZdSz+eRry`dTx4 zAfnxMJ%GXI6RCStB41)av0>_mUK1CE&e;IFrK*#qg;;X4tH^@uq%Rq?z*D&cBn7(G z%f`N8K(%4u*k)juocrTVx=H#vlpxO5GtLhAOGw>vp*i3LXbyC5MuETMu7%@`N?EoB zTb>PC;?R<35WZqz+ds>ra^@*qm70-jyg}Z_PIZOo3n%gaqF;RQw)1Ba{st*Ylr6zF z7T*FrsB5}%cxC^BPTL6o=b5O912QUoaXe?9S?csc2&mB|@m8`5xVdM*g{Gh|s(bhA z=kuVm!2PVpXOO&id1A&|L#UN#ZOuX$uh$nK13E9#JDI9=8W{ORijTkBRB&8CUV_N1 zko%sA;p@Oio4cZC%q{|r24NstZ62>cz?Oq#%lAin2VB}5?6mhGgC)-d|6Qpd3%pC<63 zoYXVX(=Qd=L2qt#&vyb|sesRWw9!8%MZL-fw`GAZAH12$QgH9zTxBQb=q!bkJ}I8t z|GsXPXi4G3yfETVV>DSDV7cmVkfb`R&>Cr64@@{|cl)bIwW4ztIwL;quk_T5&Rulb z(_9?KISn*o0H5v0c;&1FXJJ)kXvu{qhj-Ko=lR^y9-DIR7T0&r>}T<~yrY|J7R8wz zxp$sC+f{PvYF|iOo%^vvqg~lImAkV?-j%>F(AZH|KObs=m&EjrCdIfXNs6~~7dN%f z&%6pX%H06$$_96|TO7%;uHmR3LcdBH(qbR+v9OgT)M@pIeL`X_${+Fq>ccr1T>ugX zj_nkjPXoIETR_=B7q9^+TM7p@P%V&U3-b5YPbfp8Bd`?@#a!O||Bn zmr43u!>QoB1*@1gAK{(g)jF^o(Fmm%+^n#0&WV?*bsBlo^-*^^9t$h+#EwB`PnpEqI}Y>Xc9~kP8Rv%K>wMtsD!I%g?NZ cjjKXgzgj_q+!3DgKeXR&4*&oF literal 0 HcmV?d00001