From 8a71e9c3ae36613d2a4c68fb78ceee6b15781250 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Wed, 25 Nov 2020 17:00:41 +0100 Subject: [PATCH] Fix #13 Use a responsive docs theme --- .gitignore | 1 + docs/Makefile | 2 +- docs/_static/psycopg-100.png | Bin 0 -> 6351 bytes docs/_static/psycopg-48.png | Bin 0 -> 3738 bytes docs/conf.py | 19 +++++++++++++------ docs/requirements.txt | 2 +- 6 files changed, 16 insertions(+), 8 deletions(-) create mode 100644 docs/_static/psycopg-100.png create mode 100644 docs/_static/psycopg-48.png diff --git a/.gitignore b/.gitignore index 1abeb25fe..b8fb5f22d 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ /.mypy_cache __pycache__/ /docs/_build/ +/docs/.venv/ diff --git a/docs/Makefile b/docs/Makefile index 64011e35f..f6ffe8d11 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -18,7 +18,7 @@ help: env: .venv .venv: requirements.txt - virtualenv -p $(PYTHON) .venv + $(PYTHON) -m venv .venv ./.venv/bin/pip install -e ../psycopg3 ./.venv/bin/pip install -r requirements.txt diff --git a/docs/_static/psycopg-100.png b/docs/_static/psycopg-100.png new file mode 100644 index 0000000000000000000000000000000000000000..437724cf3292b0fd7c5dd7a9924c2da2d5e6d562 GIT binary patch literal 6351 zc-jHa7%=CFP)2tkL`{q)_71kh zlzYven|`m!pYq4tc%w-)(fIxIemk=+>#}>!V&SmQ^FHF)Q+DP(GxPOvadGlPME3>a zQ(3@MpoYLBPTs>^z)PU7K$t)~fw}@^<@eqKF#^j4wh9~<_*CGUz%7CA1>P6fCy*`B zO`yDv=Rf$*JtUx$K%Br9fqx48h1*-;roa_}a{{Xc#tHb?AYisYfxveHx2^7>fO}uH zK3>kfGI`W$MAe!+K~)=hQ^nez^hnj3RHmGp<$1pd?7;6Wm4t}T0D%jt!LDV>lE!g6jBo=VR_Q>QjYkwfWvH!lS9p@cHC7aRvEL$+L~gtEkn0nN-ie4^^tuL_E_~ zJ^M9*CZ&Q9@$nGY#SL?HrP@ASsP)tF)6OFTIVEu?$zs(*PwWAXi&^58kM|&maLpkZ)_S#=U;z{PVRV`4!$y! z-rPKbUS2nj<}Hh-L30)r>L8zyY5WHJPcpsb!;>;7D|aewdua^ii|hY=@Jaf7e=j=v z>R{R+I(lKw3>qz-qpt6lkjeM{Enmz+=i1xEuld1rO56+250KZj=o@4CLcAhS&Txc? zPZ_y*@{|-Xc_lY)?$QMM&+#rrc8E2uoeHM?+af4oNursYK5pM|7JhxGF_}+V)`oU=8lH`AmCP_3BiH~u@sUJq@Xb=X~pU|EdH2c zuwdUSG8C?!3ZW76(wUU!o}H-a8VCzGAELAzB@rc^kN})s$F~Rn@V#R3b+*G!yf%pM zk&+#E&&g2u`9x=457mYC7qDNFpKz4$)(8)lAZ1#=m6-TY@t6q2txkvSU2$km?T2zKK9PV zdESG~BVc-YjiQkh);E+VsL$wq4n?Nom#GVPKpu$WL27lWkw&aVCZF?|Z_F7`c)Bef6eo z6(Qawosf5+G~q|jTs+4)rA_DuYRZEIgwBGNY;C;_7lc7sbLJU4H;kg5v$Be`48Oi< zq|NKHa;Ne4(%5**2#O&bPvje!!P1B`o%O$myGwKVoemo^cOk8RZUV0<7%4CoLL}}e zL{KcqdhY+hn|=A7(7K@zezZ4?zB?L9UmxnhLIl1$_quKCLQMKRp|j+YYuR#W?B^xk zbRs@;aXJ(yC|kef2kRyT(?vkEiHJBc%Fu!8yJtlQPE4Cm8()Z`of}8;Iq+xbxqteK znS32aAEv7iAvM7?gYRHQ!FR9_+q$;btYy@8befv3_8Nf@__gV=4yMKL;@)uGgnYQi z^ajtdArznkyT-0y9S7&3gDlq?Ex^dY8il{liA8$V-=gWO13mfwiQ<`fHZ*u!FN&3f zm2Ct<5U@axwhZJSzkAaN-Go3h$F+-dVr_o^4?(h;reYV(<&pS@SfI7uA5zqS*-LDG zH$F9m+Q;PDl(MqqbXK*Y*#zIk2!yyIu)w3{WBlXcD%Gu|Nm*Zu4GaDeock{w<`sAm zAtc!PZeZeK>LWy7Tb2V5=|4V`T+5VEK7LoDnBUJL00G*1OvXIjgnV}-lskEWkgl{U za|JsGYQFy*IW2uDrzuNdDvU_Vxa;`YT?6=Ui!zFEoC9^#W3YQ*2 zu%K!+n;a5S7tV!#p!NQTw-4cKmgh~iIYMl$Nq9MMjVT(1329>_LLzZV!(fy7{GB(R za%xduvv!ihbFrT2m9+4JKp22^r}L~us%T$XcuWVD1K zMME|)A|dQoZ{ElBCVp$tKu18>k3I8+twsH$(BAb54=~N(T4?I(7^Xf;{pr%7Cs_>k z89GOej-!SQlvA$UTHe8O(H*V1qhPkcH3(|c8j)g4VseBFyZiICu?y##k3Ay^`G+JV zVToyURBP;`2pMZsLZFZQ;8v+RHwXb|dYx0bw$`5Wg{`$Q=}BVVci!&;GVrYPQt*H> zs`MJ=+HE~xh9ct=>!?Meg_3Sy@i$@~`=M`W)TS>V>q={%ok%|lZ5%quu~!H48u8-u z<7q`+3@uq1%WpEKE4W-SUHyDQMMDPa_Dn+4hpYIu#WeQQ@h%((jK2{nF9{i7=wNFZ zB4f5|oz|$l-98t@eu}|!7HJNo4iF18-u7<=fzCR^KssI=SgH5PbY4MMXDG4SMJyGqJfNt>_EVX9?by)^rO5q?lagUe8+67VqC+85RT$z6o zSX$B%PQmu$HzA81N{+%dzdG2{+_{i=zTDr_Jg;koEz^f1U^)ztk@?VRSnmkxuSUnV zQj@SF6Ku${%W!VwQK4ix3T#$yx+3rQ{7xL~tcMghoAeNZFjd&GF!jMd5-?$@3Kzxb z7$K+M1er91%&wI(Uu2Qd2&pM>y@F7x&{1$M+3T2H(&>bbQ2`F0?CYa@>O#JW-ch0~ z1XiJipQQy(DWhRXaA;EB;0 z)TGB4svi(WjY5X9g6lP84*8Br8uoTM_VPIsET6AROQs)^1qDaSae7?9le1 zcbQKxO@T1{e_Uz`^%uGbMzcBTbVveKtkYPHjNb)%8Zu8E(^cD+9->3q(=9PFVr3%b z{e&$-6uuXVAVNlOOR;)tMiO5WI3|VKPc|*=0Z6%y%AnQ*O?m4cwHjJVR%ZqLjH-t; zhb;f?TkQ&2Qy(TF%1V4#>O{OIjn6c9xT&Ipt1S`tBY`Lt++b8fvb~#laKqs)?Peib z-fu#-+wrr*Z{L6R5?;I^U3m>kP@R4m5s3otNvCEDg3S#Jyf#o9M}%a8gP$ z4+0RM;oh|;?!ub;nKbny<4Y3K%ZYXxhLGX7^s^mLa0hIDVeA7T1H!`Moar1f@5s5O zECUUK%!*#q(o9GeF1>mzfTsqO(s&SryuN9a-J}}@7!g%?4?LTa5ckqd$Yxv$>FRnx zM~)o7pF}(*)&$f}LDdH>&aea9B50(ng;J%V7k=;+C);TlLXK3cRL-=ZpYFsRrnPhX zCoG}At(is*$?VC)x`UjMLk@t>)f*xC&$s({~JQ;+Qd zwyHUq2~KB5=>be7onu#!Z{#Aierztagt(Z>@X@wK&CIb@Yt~G%OGcOJIkf$yNUnGF zAd);`*@bDO)xcSbkgU>7NK;&P?nQ4?W>W4nju5d&2r4&N#z@_7#LEbi#@$9LLWY-S zLVDq{Z{BRnjUSPeZjQGq3K&7f$=ub0Kam1GYZ*VcMst6qp}QHL5SSFCX<@50HM}cL z4`?9$dOUy^TbQoDKHQz2PAodK2a$?PHI_;$E_Mh_z6VQKxrDrW7nz=BNJ3;(Vw5zt z6*9oNy1GzB_cG@HLkGEZsE15Zo52#(!zSd`nIN`fnM@|*RUkuiLlOeBvot?*hx@m# zNDC%5p#0~(=<7Xx^k;!79_reOK>BotU!hoC71*3tgvIwk5yBxq(RtKvd={1WsN%G^ z`_Ku2LqI{&hd#aq{bqXyyTJiTimuNO*NMil!UNoobVY2SULKZk`PBb zaG`WEII+E51czo zzLi>#seuqJP-z6#h)PN0HRR&9#}y$*j7rEwxALw$GE{vjTg6{sL`0zU3u2zWA^yHm z(8+F1kq1o(uxGQW>|n2;s)`gJBNBpuFv_0Zh%O)WqaP3W(FdD+XwQn4JZjR#!oD@5 z8GW;-ZK2AalNKcFve-I92wni#$==#BOcNm^lhaMs-rQD-ko86+mZRlQ3*MU!|!i;oDGZ0&oNf+hM;y4PEB{MDwZJ2wVCaLd>z9NTT>uKif7B}fMd zkJp!ifFc2wB{Z~X`AJLTbv@&&15eU#Cj;n_@+|(IHzFa}Ly(q4KUS!4q)Pj;6~~Jr z#W)TrNKa>}eLb{HcdBMq?4mikp0Qc3J-s_rRn>lK8I6z+ap+&W+tD?ljCHiq#*t#I z3X3Vg9DXf7n0^wvMUajZXH_!`Ym=jMRZ80U)cLvyfu)+K#duFOZABW%W7r1&?eush zZiKB!k{^zCrLPb7xa;^UQUjlBF`~3Cx>{noRQka%nFpv@5fv{80<%BfZr)pJoskGx zivPk%r7At&C8qB0#R}V95|b=sriue-fvO^;Wl>kV`Sgp=)Ga(9bph#i72G%;;H*(x zxCm~z1l!M#2mRT!VM{Ci@pxB`FtOEe_)D!&FZ)*gf8y2rWcM&Fh zT-&at2O4@+k3RA+3F(4A!(_ZJ8eyv{4=k`B?&)W<;opd<48}mM9R-&wasgG9g|N6~ zMXo2R0^J}TRfMdCjxpgi)wJbl1VXU2HEm9BR-{IZ0{WJsFy3%TF-l7M{%9!uDtAB7 z3am*G2H-M=)9YG(2<_W8?5^{UNYlyqv=rThD23L-uGQBFgzUwiU%t_ni;LN6*f8mn zcx{7ehnx@I?8p9*{bD+SX@!-r&BJwdmXfpxmK%8De z5TpT{+rCw1FXCJy5b`;cCj`H#@~qaFDs5NWUmi^Zg_77$U`%ovXDg``vk5xiU`$i6 zWkIoo$s94c@GN4dgs&`WE&eR`*wvGVVhLEOzuD7H5wfMEdkm4ldCRAnd!e0X?lxb{ zueCZf{sxm3cEIIRxd^yVC`4nw^r=$~tt$k=n_Zo$Enz6<> zITynlha$z;)foYBDCh!ncX3kI;4?>{8;WDD$eYR|rHe&87zq1GhrnPBRa&D#Ew=n# zDCvY?^D9ajSKqEF15y^GsLNuF3DQ|~tT+gl_1Z1%YI>mx3Dl~_yXTxM>4YR(dIs&u z`deNct67=5S5VO^7>Ul_Lrr;AD)N+7P|^v(28wiHLmRG;W4{pPavmi(4{p^5L5MP& zIO~}NP*@qBPdAg*_i#xk1Y3;KzjwDa@9$v`8L~*(0aOijWB=zSljE@i_?$V_zl9%?tA#L@M1yK*1aC&DsRRBM?fwXX*(z@hh{ z5)eiQYH)GM@M26?NF=&>x;@pe$s+G}E;eesmqf+zhia9}(yu21>DN=itgLBiEX*is zHyrEGo#FtFF}25`+T+6+OkbE}Dp9+vg;Rd@hiN)lfIpw^R-OJR2xL<_8sn(JSZJ}h ztBq9d#hMaev6Hmg)WsP<3WP*>BR`OQTd?W<4}m&HAq1mjH~t&msTy5B6-a-c?qJ^a z%+Vqbz2xSZAYOpsTX$A-hdX$O+KB?Y49EWC+{Dw7Og|DzH&8%<(Gn{kTx()b5{Ji9iC8(#kQ? zVSSKf92Y2K#HbTQExv-oFg6~{Yh|u=i)jQYY+a_Wuxpb-P}_GFTT8%;2>(2U1*``k z2@5uCS4a*8ajLv4LUszC_o6Rf_bpU$6g!0C`M5Xo8=<{plP{Qg7Ujfp(kJv4j8e`H ze$kr{$|T8nPoTDuLrKfZe32XYx<_CY)=?}w2>Uppli|<6bOo~pyo|6nArAP?CM;U> z%iGh2)TYY#N9u)0o6vxcu5L~LIpptn4|TCtoPVhe#SX1QNMM!s*(KmnTGA1k2)yPZ ziv}PX1$pZQ>%4^+S@a$rs4{nP>*E|T2vNF~X9aq^nFk9Dvq#mV=jJx1^~p_WZe%?^ zhK`p32udtXlu1LETr4uUJnKF}{X?ozRNtC3b#QIIck1~1H1Vlggi^KT%N43NdcmcL zU2_ay>qLAyN%P7ts==t}(EPCq6x5~?3jqVWR_8(kk5(;bD;@5t3{tc8-EB!ifeg}f zw^3VuoQo;53q=jC$b1jWd;BGX!?E9c9DZ+ci7-U*8M)|plm7R80`I$+5=L(cTod?I zE}p23vRohrz7~sVu&zKmfiM@-R^VPPPSin^_j^R3hKp$j>&o|vfO|>E{{wa@q?md0 RvSjf|N>kgRmeWAT0*D zAR!^bi{H%m$NR^7=brPNxX(Fv=FZ%i6Qi%EK@MSt002O)rKx6cgRp->On9Ro;+;p` z0N6oUR~Z266G$(u32uB4#y~>_sKK&s-8fKNO#@v3@aF-5;BWxAxCsSs0)W>|m2E2k zfM)^#gGWy51G$?7iMNNc!~b^xu(-H~HwK}Nj)ofWf9qVeE$H7d4^30dO`BK$1T^N{ zqo8FX0AY;u|N^vxsl5rwE?#)9UfvtE_V+>zK%M^(}9LxIRed4*~5MSZtz@tSNWaFkINr$FJm6D6Ewc~XuW+2%VbI<1dTXB z1>(ZI5YMPGvcX5awpPh0mQ8lMC9-lMFs8Z5ujZHzK1okVdKO9!P4Y5gd)u-36EpGZ zi%oo=#lW@Cd_mF}Ul}_F?l9GU_^{ypP#vL<^BqKck3D`?i@awur8t+Jf?{+e%>zWJ z9(%%j-8p1>`bduoPu3vBdRn2PPp}hboF@k6I@vB{DO|Sq6_4U|!;wg#kUSO)NZ~d9 zLA^!(+KGEEh5qB$#3up8>rDJ*{`ubs6fhfS)Wdw^!8AmD7b|_ZMbQG6BSWj42p5I~ zk;G?ZE&A136O@qKM^#6W8B znz&`oNyx6yYme*8c4aDFztUd?@}CZG*SHMO0hOB0GwjJ(;cYu&y|^zutHS_O z<)~JyrV_2&^hz>N1xlrld5oi5eM7qF_kS z(l%wOY|46u0M>(YIjn^Atr%Ij%K5eDmp;oydL@=tee)~$@wMNs{DdMpa(-8uDxoK? ze?xZ-5?qrtvuUsyO}~kW5|2{3U1-IIDL!$G5%i4T-bS5yq2%U!j$HKgAJLGzGmKdM z{d^BqFU)ZjIGWM%bDu45je&+#MYrQ+b4|Da;EYG!fsf0a;4_Q^7kuy5j@AJ3^L$B# zn~n)EX3r$eok)zDX9_;J zkNPv9ai$R^i+|KdK7+>VLe}@F}n`dKzAbzGTg>v2C6XQ-%{4(1GrKMv$+l zLQ_qu-fTpId2_p71l@L3nma$GV>ml+5U3&ne|s2LE3pt0Om{A8?oK!t;hO%t-&D~} zFeb{4E<*Fwy&4-aD>k|7t#FRiz5BhvUW|uwrAx`Nw9TQjna+d*W5wRcv)woj)Sn1^ zOD?CPnQ@7mH+NW)S=7E8@S zqdRhb)eT1F*&9RqUSi8$QJWX0rn-s#xO5)?)ifGBGiCMPnIsrS~*3NwTZ9y zcoG37v6|8Fr!!UT2ayftAH41b1tWgUIY%HeSj$51caIYk6^8uK-GH+amht@((fsG{ z=)|ji**2d2;Ow{VkBEz2oVqYrcZUD?_O2T zZd^`DZ+2Q!iii@%iWWDoV@0%Ad$F&y=qlQC_>f;yjVN-5(#i0ZOl}{@R(-vFN0FUV z{3}#WfNi%J0w~LIANGGZ48*U53i528Fg0>L87yG|G`JIpNH$#w?OOtaQMf zF=$P~l)K)8&0MB2Zltrr#mdWsKXdG4i%$Ff#4B|eGMK zUnNCfx0W+b`!=wY3Sfu>ZJQ8*j%V?->mwyedH1D?sVWoH>XjaFkgv`)Wb?^jI(zV! z41LJJPWi(`)rI`&qHWN7O$D`cOv&m$dvO*?2VXpg@(-5N+ZESfp7k^B&)@VgiJ1u$w$ruMr&~rV-1^3)yX&oABF;<)?Sh9BJ^$=gT0;ThIKKFWGj@rj;SK8W9dl^qzI--2Be*Z;A(qjvM*EKUXsi3;%U9eEb>^N#j3?F6u43_FG_!(P54DB%6pEW!1c;Ngvx? z1h}l^!RuXI>>;FUF92^6v~;|yt8`Kj0b^j}I|ZK66F1xE^|WNZIh#Kw;HTOFdl`vSZ1oDBv_J`Lk@ zsaY*1E56lvo34+?`d28K+pQ<^P{YD0A!OfwXax-hyfp^eYw?0LA)@bnk~mnGIbIF8 zNon39(>{BqKYl(2$@Z#{CYSuIP2U#w8ug?}=?B!4=1E+x;l&OrQ? zMMQRQG2O8LR7#zxCq;+C^|acUS>jFWP?kx>{heJxX%!PKo+{9@^PSh{Ep~N8QJce)nC?e+0u~c^8vq#vtF+XO3ue zxzMW9E&Gbcp)SLXSE1m%L7veNr2G^+7a~U4wsPZ`{cXGZ<)H7$j?i~+{RZ*0@#l`^ zd{%#a3|r#s)ClULLrf?I8V1Ed3o%OyHLOUFc3$ii342;;SBe#e$xZ_oV9Z}UH&sMOC zJ4WU>;gBh<$i&khd{Y(MN9-s{y*dBTbFN?9%o-zePzqmTK}eQtmE?X0iRD9j_j2Yp^}T3i{n6OPKo5 zj;|-uqMZ5fEj7_rT{;Zgwj3X~fvzV1nDszaSKs>wXf_7dGiMhYM#=(*Y9ky?bjkS6 z`Z2phoz&cAT&LR4)4Ct_`yut9lQiyaU*UF8^a31d9@bgaEcr9Izo#PM{9XEb)g z_OwrmRz=TLl692<@Ogy|`8){aov){-CY4(2z(dt{QhlcXsbZna#af$5ekI(R;BgwJ z`eP?STfDqf`0HI+GshJ^EwQ~9wY?O2GeV(#5;}z~JXFFspD3)q_4(EZE zh1{v-NI$0S($h)jH-l+(EB=(R)I17{9d189J|{?@Y+iu8v77c6>m|!?cj9+598(}@ zf1ohNwcW0p5eLohnoZ3#>rF2&fde*QOF1F%w3F literal 0 Hc-jL100001 diff --git a/docs/conf.py b/docs/conf.py index 11820ac09..d542a8d84 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,8 +17,6 @@ import sys from pathlib import Path -from better import better_theme_path # type: ignore - sys.path.append(str(Path(__file__).parent / "lib")) @@ -54,15 +52,24 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".venv"] # -- Options for HTML output ------------------------------------------------- +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "friendly" + # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "better" -html_theme_path = [better_theme_path] +html_theme = "furo" html_show_sphinx = False html_theme_options = { - "linktotheme": False, - "cssfiles": ["_static/psycopg.css"], + "announcement": """ + + Sponsor psycopg3 on GitHub + + """, + "sidebar_hide_name": True, + "light_logo": "psycopg-100.png", + "dark_logo": "psycopg-100.png", } # Add any paths that contain custom static files (such as style sheets) here, diff --git a/docs/requirements.txt b/docs/requirements.txt index b46c7a155..a6049581d 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,3 @@ Sphinx >= 3.3, < 3.4 docutils >= 0.16, < 0.17 -sphinx-better-theme >= 0.1.5, < 0.2 +furo -- 2.47.3