From f86fcd3a43be465e491cf58f9d2c30c257bc842b Mon Sep 17 00:00:00 2001 From: Erni <38285979+arnaujc91@users.noreply.github.com> Date: Thu, 23 May 2024 18:54:16 +0200 Subject: [PATCH] [ENH] Improving Documentation webpage (#1150) This PR is intended to change the documentation (jupyter book), small style changes as well as content and organisation of the documentation. Co-authored-by: Arnau Jimenez --- docs/_config.yml | 2 +- docs/_static/css/style.css | 7 +++++++ docs/_static/images/tianshou-favicon.png | Bin 0 -> 10901 bytes 3 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/_static/images/tianshou-favicon.png diff --git a/docs/_config.yml b/docs/_config.yml index ecd45b8..925c994 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -50,7 +50,7 @@ parse: ####################################################################################### # HTML-specific settings html: - favicon : "" # A path to a favicon image + favicon : "_static/images/tianshou-favicon.png" # A path to a favicon image use_edit_page_button : false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in use_repository_button : false # Whether to add a link to your repository button use_issues_button : false # Whether to add an "open an issue" button diff --git a/docs/_static/css/style.css b/docs/_static/css/style.css index b9f323f..7a964ee 100644 --- a/docs/_static/css/style.css +++ b/docs/_static/css/style.css @@ -50,6 +50,13 @@ h1, h2, .rst-content .toctree-wrapper p.caption, h3, h4, h5, h6, legend, p.capti display: none; } +@media (min-width: 960px) { + .bd-page-width { + max-width: none !important; + } +} + + @media screen and (max-width: 768px) { .wy-side-nav-search>a img.logo { height: 60px; diff --git a/docs/_static/images/tianshou-favicon.png b/docs/_static/images/tianshou-favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..3fafa0a234643ffe0d48f0519e0cb6273de72fd7 GIT binary patch literal 10901 zcmaKSby!v3*6wDzl}&epG)SkElr#u}q?91t-MNu&L_it@>F%yg3lhQx1f)Bq8}8zF z&Ue0Z?;jT)9_E^B=9pu=;~itJaFw^R7^tMEAP@*cUQS9C1VYjS{uH6lfSS-wNCOB2 z!L*c=RI!$nm9)39cT#isXlyELYG>+XX{;(M0Rjm`M{DR?kZa(JrZv^D(2WF6=I6&_ z-oH$!wNV`pn%%lLt+AbF{bE!5I&N_9PlhD}&+6@WOD0kL*VtW!OJ9~Abh{X-txEPI z*>Y-Cav*^(F2}BAzx^UY*=^#fY5CG<-8M9TwUK`4x4Gbauz(iV$f}#PKo4dmEoWPw zSgGmX=;;x1>GB=J@Ev1giAiKmWI!TYg?G&EA5!%#OrJMgJecp6tH>gS{Ry5a75G83 zVhXw^=&ja=L0;bspiCQGqV&A7NvB%D?XCl95ocoktsYJJ%pGPR&HAD^>b_?#40)6G zTnB>e{C6%!_+?=k6U~tHAYV!9TiS`Xz#IR1=|9#zbAigSHJrZqi%%NQzcM=|Er()f zX{^n=gjKLx*7RaOm^N9W9MOXGTUvviP>)1=j5WMl$+ujJiuuPoSqdgo%&`{(JzTql zfAk$l-PUm#q@%j}sivcEU_A#dtuV7ydR@>yuT-*R4jYQrvf%4K4!dmJAT$H}925be<_%KR#EXTa8g-$ySJ@*y4FWq{N5_UzhCDn%G2pLN$M_xFpx(tlc4dA*Y3|Dpq^yoC(sh+DlwbDsM0*I5qX)&if;{&K zI1TZn;;67JeRK_T3s6b7EWT~!S$w-hEbT4AnXc|Z4eD0+1G`(}oD%sDw13Bn;fEF) zw5{lVo)#spV<=`0w3A%&9P;sjm*g~G);LM1bE)DP2h~iXOvZ&2Fkkj3(Kwr&G>uPs zBGIa5@kh2sZn?kiyEivUUaB4KRmkGUo*A7Pwf>PfZTCUQ*G?<4MMg8LWy*Qmh0dJR zip^zUb~3|h^Z{rve|Ju^;pHyxuqLW+v%PMQ?1{)*6VW_24V#ZO zxjEV|HLt;xLm=NKj~1x;Gu_*@i$Sq?>%oh7N(TScg*DOT5$7zYEXPIIfc_G@lYx_g zBc*eetktCFA+Pm8MQ#=9hUM3H^H~x)Gi<^yOoBz=-EfmP%3A~>K`0+NyxjOp@S=(I zTb}h-+MAU4mcodNocHWXYo?aP)Mb*MG5X}M9`ZbSYquIiD=$Vu6Kvb!6|{er@8P|%W;M%GYY6Ukl zA^Lh}_KV%-trqg}e9XG97VDr&Z*Bp&z5M+h(VSbua zG5g`k1HA`Yukq9n01#59@8!*ult9ct843a;;ewt3B_!Y%6lw{A{8I*j7=ZsE5I7tB zKQ%~t*-!pcR(yPUm{jf#bkw#~fA8{MNm0ny-j@BNiM^32yN9jAV*`+|hY(P-HFfz& zG&GMB{paUj>vXX+``?-Dod3NoV1pcwZ#cNv zIXV6_Hqcf0u~tag$<`Eh(vF5!P#{$F+fo=2GDaq|CK%)fT}Pc5)jQB+}$|APlyOGWd7M#oB;MnO7b zc4e|SPtDRgr8uK2CWatSD8mZ*mCK&Gx)A}320oj`I>9^YNBB;vg_K)iU=pDi9J>fJPkd3L$;@*i^1D3JD6ljDbc~6&2V! z$cfau#_F_G$l6AH*sQ}i!z?^6k7=E3nA}bC#Z$1gT28P#yI~}s{?)*Xp?P@l&fR{V zu%*QQ*67tnA@!|JU?xw#{?DwLGIk-q>YW1%`#;oXk@00G4q_LRLpx%b-t_r8saJA_ z3cOJJHjjX_9`DT)G6a!k*#!;?AF}vTu6b6eo#>4eOC~Af{9Rk%P6%?AD#xCPVJ}q> zltCrJCX)S&=Uu7g4w=31Q0g}WzYT)33gr$PrRSfh41;0M54|G$ZsGE)2!H)LIae9! z&_OfdJco%0gw@%?U9nMGIM*q`+oiuR!((m!6uHFLo|RR!v2VZo`3y-Of{8V_tSaAD zc?i3{{jxh*Ml`}-J+_toJJ#UOx95MVy9Yo*H?maM+TYvn;4;=B7YReO8a;9&h`@AY zbVzi7s^|Od{)P|pIeu3=Z*v{9gqCHl5yy49B*dSdg$zm675J;1q0b0%>TGO&9v9=v zpuh?1+ZNf)NjI;|%T%?9Ob}}^jt#JCmRQ0LsQ=7SR`|m-5M~I@D{Oz?Wcl@Ta1mbl zRC7VaqMTp`bvBAiL*D(jr{d5?TI}cvCCMi;*HO6TpUs3Mvm-h=pV|>%e2AdSj(tgN zN2ezVqjofoq)E{M$P>AXEisQjCVG#Cx66TT=l-UV<@Hae8g+_JyZ&;L( z_dLn0aH#}!Fn4)T?cHdIaLtifT2{)-T<d81~KQxlJ}LT zbiryt(|_%_P8(kKm7eYWgY4#rT9(j*I$AvTHzL%IRd?&$9u|`xLG;1&19sQlJo7^S zOio*=5}9nRCSw*pq&Ax^TbAh}d$G3H>A7Yo(;E*CwZ&d86%uu~KO+%2-49eN7M>Py z?JV7MxoKj4O96>iqYHuDB3qQIUhkZBb?3$^b)2r#-!&l7{GO#@)s1Q2&TZ%ECa5VW z5^H%tdDr*j>JPOsE1(o@_%-$D-4JuS}uRXVE3jc;d#}4 z0m(rvrwQ6SZD^ak;{A4N;A_H7tq?OCIrsJV-o$cv;5?g^b%o3}_ar{3q6jeSdN4^WTE^cjp2x8}I>XtJkFky>2((-RJ@ZNi6s0jQ%!Zel%>0RW4z3~ z-e(ysNDQ@Ml0z&`;(c_2eb(vov590@Fxjc&6WrAo_`0xQE;H0HJ#&S)dm|{iGeJu7 zdqX*2Fb(tkb$%5;9az19T6(UnqI>+B8Mi%FzVW~~wyznomrkgu#rujnZoHX8zAKep zPuH0SQ`12KHGgd1w)ZCk9om)K%!(H}pT1-gHkhz4xrlLiITiPN2QfI$0_ppowkJk= zUD(h`T+U(#+n+7lR|I_S5S!kg8NElmi8&L0PK7#cu!*I`#a&BmxfL37(~XcJs<@S0 z6rALDA9QbiY1X||Xy(Zc-u+FbLTza5qhXRFO!k&(s{%t83y*&*Eeh6}oR~u?$oHH% zwg1ki_L7$jQjAioO={p3m1+ZM*{=uNFn3x`lvKw>LPxT2*+{-?@A?Z^Ue@7V;GmwB zn*%G*Z~MnrM8>GSBEy#{YzOg9)@2>;${y9*B)M6fTrAPv-_3ox*S|&imWMUbZ`xfR z)ad>Qy#5}o21b$flBwUe`Z0cfn*Ybje?+$W203(chHKwSqP7|#=$tQbtk;-oreRGw zk*m7$M$B8`&)F8K>-x$U1esa$s&H+EL7g&rTAvl8?{WQMtz(AOLG9679}$`GeJ;1C zzaI7gjwOU|nUx>xkf^we)N9`PAfDCPDl6CIH~I2$C_H;ZG_1kpg-UP~8#J3~APEDPD z|0%@YrvGJ-PRGk;+v+8yxdO`A@`arHgVbr$4`;IxX@=kXQ)Q|}l0sqbZR63Bls=Y2 z1FQDsLR#Cp%R!YS^m>CZ7gO&Of6-DeuN(R_&nR1=ZL74e552mG$paYSuPNl8klXoJ z48*ODGD~m7w2L;B_eM^qIt4*qph50l^3_JlYn~}u_<^T zhVNK%jag7eHIL$=wBZPi@aRxe2bL*&tx?+_lCjvK1@Y-bvLYYjbj+s&dK+!SE-k2D4vKm^VOAeS`B`z4RnA8 z`)AF=d9Q7?&5usf8bQ6g=#R!VK9e>>nSp$zKQ#L8+tG*6z#ZFbQt4+s)hqhnhgesqnxefg#gB`KlCtd{P2z>!Y33j7g!%-_KDTH|XS& z-zy;B>3T}9Qt0)lOA5^~iad_jP3Kkamm~O-Zja>P#5{_P_nm#J%MiMSU4;Wu*P zoy0tE8tYN%hme0Z=eVNIq+(YRG%zq;)qzo5ilR&b^U#t za*SSM^Z6Ydkyr$rWtL3OcAY6l#8mQ`ZHv*kd`d;6HLV$KheA&9q^<2?ba5JghG!0& zpPTsQ-P8$s`G8>7ADm|=b zUHkQ+Cdis)lCMTPT1hCN?O|nN5-W2)JJUzI57lV>#d2L8#hs($!r%m=ZZjic)K=EY zWBu;DW{6#d^0#Nm^+D>-9e=Hk;t#WW{zo2nv9o_hw*5W(S<3FWzx0=2W%}m)I=Nuy zyNk4$Io>X?+)MiGF!4S!JGR|FzGQBijx#bJ1G?pLw;q4Bvk|$;Z_#B3rDNpe#z<;S zLp(P_;m<7sl{}}h;YGq)>5ER64UHDL$K!m{cz+X%j13cqLW1x~WEpWKVKK3f9L0%F zJUETkM_m#G#zcAFp7Sz#UA@t=a2y#7G)4uR5tPR{KgxDl-oy4^~iei%qDfMYoR zUFLyM#i1ePqH4iCZJSh1-do;u1$-W=5^+PCppJ`y!36bkgVIKvwWJ5 z?-cfmnHq%D4+)wtoGOJAIB{34j$Kv6G+t3k3d>2s>hN)wbGQIH4TjS(c#Y%~MK zoDx<>jN<4@cu+4by@nx z;0fo>{F6>2+=C0PQj!!+!?4FFpidjd3vX^1w>*=m>Ij(I?O<0U z>-~LlILB%9n{16?X6FxVvuEcRJqWp1&^3vr)kQz`ebTKVX?Kx4GZZa@rjM)N*dk-T z-tDcI?Mz(U)@Nqy)yM-KYs)olb4FW)UfJjbvqIm~W``asxr^jH*X`&%pfJQ>OK?p3 zn$wJq^t3pKX0;}a5%Mi zB=wcHzVG>b0{CP*39;m9c_Vt}&taosZ7`QRwKxCjN0X`nFXc27fBOtSvq`wy_w@#6 z@6mC(wB?LWJVCXInJxdm(=h#LHrGYFg?0m5&0Y~x8v&t<%Wu(h>XyBg*98WmC3gOs z!B*oa6Fb$FbrYKN&umH5={FzEbJ1t*s#v5oNL(0v&9^1nS3fp1jWHBND63IQ{*I+S zMpb=(Csg#hQLuP#!F@AuN6WfKRCVNNI zTe{cQ&^s3|4LA;!hx1P6H@~o-ATRBV9P4Ko(U7j_OW{K@p*t2~ctZyao3SIMO{2M;fAkb@=xOI^m! zhGQ^JRg0LqDY*Gmj-Ucj1k0%vCW{Fwvx%ZIuQD~4-LIH60^a+^L=L3fpjYfdljB2c zx@I`(apQ0i8haC|;I!WY5|tw0j0_njHIg$?zhg+<$Ae|{6gk&0~^ zY3lw$%#<@s)^gv$+fJhdt-6glh)KjZ$04UQ5qHFK@3X|=u-iT!&L3tR%Y z9ZWPGM|jN$1W{(rg8!i9&g3>89#7G9mjWE|X>&CFyJ!n*u}g0MY?(J=!xwpX+qt@; z!C%fby3W6IFzET~;R4nY6vQz7A&cV?Sds%mG! z8IM>+BMS)I4~u*0=2($&s@3ouICB$c`Gh2>xB{BS5wT5K>z`+=gn}essQd|XS~uED z!A9&t_8;mBT0>wjz;t@=mK{u@2AH0{G8ax4wXUWOD+~~K0xL4nnaf~xK^PSDStK}l z6rE*ZLAx<8Q-KUkCkkgC_6n%d$Fh_l$juDDH2D)Y)I=HO<=s@tYwFCimOE=0Tv zsgY3&A#|Rk$cxLroZX--e7>1>#>* zU?PCfCBlt z)M9LtqN8~gMxYHn3I!3Ai&eo@ksz2lsqP2@yU`e5urM6*6*wdPUr9MEcU8}sp08Pl zV))Ic&@2*fe9s6YZJj4H^Bi;(Q@z@r9m!7GI8+ z|GFzfAGJC&60=^>=fR%Y8KOnyV|0Z44z`r@w_~AnYeP?9{LFzrODXs*%ZOq-&`fF1;=?+RNCPAaP`@H{HEl zFS%G(mg%ZmR9obyuVwKg!%Ly7{|tp$&nk;0-RffZB5_nTCns$akemoscKFqGmVy1x zOcr_CA*qkH3SAHxc)Mc?;<)UuVqwh2Q)=;G-8gXu$J}_|Hsaka_% zGh&TP^~{nKjdP7mmMnrqEWeiw;&9vH{J&Z1xb`)h3h{-tgXj_FU(Yo?CcVo|HRoh_ zO817M7(Yn^79W8gNuHZdA3~>@Ik_9d5nWDrQzJ(yx-Uezp6@u| zt_jFOZ+xQ2%Z1`^3D3W4uX+Lw1z@pL<=@F_f^yn1)yahGXSu;RI`4Cp$0Mqe-52i{ z2tVQa*lgEU)^`uRWf)5@+zuN}x};ZCT$KR01Dh1_>MO2!AQ#9dQ;i^f#pu$jwO45B zY2%%rYIH>&nw7_qte7F)=nCe#zbW07GF*UMn)643Zig?Q&ZnXBFDDIjVk?N34gVth z1>XtGtt- z4>5qOmWTy*0B_;|*lq}!w|1u5%O4TQQ~$R8-x7HlIGh{eSvH0mQ;E-p6i7RmPdu2? zK`2@tFbPh32cLo!-Xd(8=-A=^y$uN7h4NaF;t{8)R=UJXOrgc`pMO%O8cPKc*jdZe z4kW`eRSg4yP^-{EGR&zg7XEhrVmtdcRN>>TRrip06Hve2#~?QJJu63}p7$Y+;N$jf z^)Xo!8?eH9DfQB4ws%~1G)4L`pLtK2RHy2{%kx@#TZi-+_V3p&&>)ZZ_OCg3J^Hg)?*x z8-o%bKyW)pqi{xS7|a3ucu)z!p14F~Nfv6f=c2!72awMvXDO%IKUGBeM3{|@PzzH z=~F{Om&=qRv?hK6yMb~0HSb|#tG2egXu7p}v0dpl<16wn26k~O>12QxvDH-6EmnxE{y&oUA#V*$NA)4Tm-BKb@-R9wd#@FtUOJ}chNCXBCrq9 zCSaOCpd1F=3sK8ZWKn|x^q`!1acFJ{F*Mk-d2P9%N?Je!^Vm6hyT;m6bZg0(0Xk@= z9YlS~e5|D<3;+(k#Q3l&VOZHhOVsuv7-kI!v^+f59v?}6dA7NhfA_>emShwYN=F66 z=^#y<)TC3Zk8nO_y^ly;>B9i);gO77YJ{|=bw}?K?^CHr!kB_dsi<4os%8`4CEFf- zxwP(vqG#v=7zU_T=QFT!SM|%#T{<1`mEaK>eIHU*t6Er$4eLV^jZ>0yc@(ooRF5YI(oq%nt(`-(a<4ljG@i?8-)oTD(#a4n60f8d{ zJ4eHo(gT$HmZ~%16Qv__Ya;m-hfkOz=OYEOA+9~c(9zv{#pxnDUw5{iZQMmjh?I{H zkKkVbSb!j~f}c2|#U)UPn|c-kUTj1;_J(;L_Q`fmgWXw4d2*^&$_s5P1sTwe=ab_o z0OH64g2nFsaBi^-4nGRW>M8X2h=(#A$@$cfPM#G;wMwIg`ad^=aSjv#G8m6(jC_0v z@+a`OT~>!Ae|L@0Ki*1^!`rVFgLkdhP)#mW++_n=y9l7X|2U!$WpbP`0(LTp1QoCW z>K~U-Bxo2_CwX}oXXDFHCF#Q+-J?+k18wq+0n#01{&M;KNh93^yIG1m@7I$-YN#;* zMDl;S0{$iu)o$|`U`k)xhi#&v@IPnNK~Qs+)3#E|@%ggH+Ez#=>Ps_VFZe5d&Lx@P z-=H%7WHmNSD8@Yh42IU47NonhbiJly*|_(msjt5Jc{!H^$5Q}9O=mb~-N675FA4^k ziJ|bI>n^Whl$=N_2AwJESIS9Ee$;J6wAHG^`U zgZ*)CoUn_O3~(6Z48po+WV8NXoiLO6`U5=bc~)qJKR9Y5H#Ua@V4ZCCJAkH(!%)9+ zQGF5*pPLE`dm>}<27nmdb~yl`s2qYo1P3_yt#S&6Yhk{>-bT-Q^M=k1JUy4pCIC*5 zMdIo0{8zQg?>V7alLG?{kwGkCG9TYtY{y_NbQ+D!rm6hqO%T*e;}wZROc5>UlS+l; zspDD_%9#FZ4(>cP{gmF`XB}hAUOX$o+e&aY#TR#Obd3}6*+PfA=T+OK<_gpl{9dm+ zlR*=&`k-xi;_x$elU|-im&yu{x63$?9c)8|Z9f3yG88)CZS$FCe>Hxa_3BT>kM-_nW6 zw&(Um0hF3V%nL9r>@a}dl93T$08j}{#xYdrilS^|!>M$#m&geNz*u#fw_Zqz2My6h{5Q>eggJ+1@@RC-?MA2|30cDC;G0RRl>18f9 zB%m7rI`rUqlysLq8y3EVkRLlez0PF=5>QArptV0gF>~YLyuUs;Nfd2BoK~&xa8c5QEtP5~}};FuSD9UOX{mNb`C9e99}^Rq}6gKLhOC<>1{=3yhGjZ^WTYowm!dx1+ma#e$W{oH}${V z@@Cm7LJFUFa_tq$>T}M0Nt_V@*k4iQIFl53-h#iUaPBN6$oebeug4gJm(K8k|D&Xa z4^=Q|w<%Q`>}Pf>aiA1T=5%^Q0mgPv05~C&9rcg*FZx)q|D_lJ5Cz8W0^U^@kV8Z3 z_%i^008SYU3bbE8Kt*yYX+-ZpMaldEfS8g()cK>zs6LiaMt1GUPr1-2|BI&y0iQG^ z0qUWhg4goYDN%pnF;1cw(!UG$g<`ZWMAe-47eo z*L(hxYaZh8L_9Rcq}nqq?TM3>nzXXPW9c#b=Q^vAMKers08KJfspc&bt`}*}(st>V zL5qF3Ux;8;B4E1tmQ`L2k8$>t4&issm1|6)P0H&u3vMyJv)*Yjct~VL=BbsrX||le zv?jIbgQvcO{zw3!@T;}<68ZJ-UlcEj)YkuvS$GI!Ogu+S@##g_*>(|<1Lo{N9lPuR zpUAvFmo%U(a`Aq)_Y&q31V)rrxzCf7=sIluPc{G5I*?>_6JbT^% z*z5&RJV?pK0b@fGK+cUw&oWEW!RSKlk%0SWp+P4`LV^YXK*%5TV)}YO9<@%&0}F`} z;FB4KGANH9wOD9lQUysH!lja)Cg3_6QPbld>;WJ^VU3eI;`;|&=Y}A}sSmR2$)Pt7 zj-e8G0Q3OuO1Hd2fHQWz`No?c8?9-4u#X$pj!&;wLF8`l_m0xE-ixVrD)dP9vJdB7 zLx|Q1GsrUg+voJy8S#U`XR?k#Cp*T|^Z8Td=!fMkxHPSgMsNObCxeo27-$SAaDOL# zQOjLLQpwGMuU_35mI8N4Wxb2?fx5k}Tln>sc{y8YtiTjNxElns;Qq~)7q8F$9xoQ| zS3GYc+gDRA)x2IxEyM6sP!d}fILpK`FhgT<5~c?Lme(N}0||Qhm>;?CMUMoerwk~u z2nM+s0EG7dhF%l#u!evj|99h{U4!9DVlejKgwBU2-$vA$`3|#q9>4LDmwqc%E@AlT F{{Xo=N-_Wd literal 0 HcmV?d00001