From f77b09d998dffe6b8332f958db970992bd451444 Mon Sep 17 00:00:00 2001 From: David Lord Date: Wed, 24 Jul 2019 14:18:02 -0700 Subject: [PATCH] modernize docs config, use pallets-sphinx-themes --- CHANGES => CHANGES.rst | 3 +- docs/Makefile | 117 +----- docs/_build/.ignore | 0 docs/_static/.ignore | 0 ...jinja-small.png => jinja-logo-sidebar.png} | Bin docs/_static/jinja-logo.png | Bin 0 -> 12854 bytes docs/_templates/sidebarintro.html | 20 - docs/_templates/sidebarlogo.html | 3 - docs/_themes/LICENSE | 37 -- docs/_themes/README | 31 -- docs/_themes/jinja/layout.html | 8 - docs/_themes/jinja/relations.html | 19 - docs/_themes/jinja/static/jinja.css_t | 396 ------------------ docs/_themes/jinja/theme.conf | 3 - docs/api.rst | 6 +- docs/cache_extension.py | 2 +- docs/changelog.rst | 5 +- docs/conf.py | 192 ++------- docs/contents.rst.inc | 23 - docs/extensions.rst | 8 +- docs/index.rst | 30 +- docs/jinjaext.py | 194 --------- docs/jinjastyle.sty | 119 ------ docs/latexindex.rst | 6 - docs/logo.pdf | Bin 5677 -> 0 bytes docs/make.bat | 35 ++ docs/requirements.txt | 4 + docs/templates.rst | 17 +- jinja2/lexer.py | 5 +- scripts/make-release.py | 2 +- 30 files changed, 139 insertions(+), 1146 deletions(-) rename CHANGES => CHANGES.rst (99%) delete mode 100644 docs/_build/.ignore delete mode 100644 docs/_static/.ignore rename docs/_static/{jinja-small.png => jinja-logo-sidebar.png} (100%) create mode 100644 docs/_static/jinja-logo.png delete mode 100644 docs/_templates/sidebarintro.html delete mode 100644 docs/_templates/sidebarlogo.html delete mode 100644 docs/_themes/LICENSE delete mode 100644 docs/_themes/README delete mode 100644 docs/_themes/jinja/layout.html delete mode 100644 docs/_themes/jinja/relations.html delete mode 100644 docs/_themes/jinja/static/jinja.css_t delete mode 100644 docs/_themes/jinja/theme.conf delete mode 100644 docs/contents.rst.inc delete mode 100644 docs/jinjaext.py delete mode 100644 docs/jinjastyle.sty delete mode 100644 docs/latexindex.rst delete mode 100644 docs/logo.pdf create mode 100644 docs/make.bat create mode 100644 docs/requirements.txt diff --git a/CHANGES b/CHANGES.rst similarity index 99% rename from CHANGES rename to CHANGES.rst index 7e5df3dd..241136b3 100644 --- a/CHANGES +++ b/CHANGES.rst @@ -1,5 +1,4 @@ -Jinja2 Changelog -================ +.. currentmodule:: jinja2 Version 2.9.7 ------------- diff --git a/docs/Makefile b/docs/Makefile index 52d78d9e..51285967 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,118 +1,19 @@ -# Makefile for Sphinx documentation +# Minimal makefile for Sphinx documentation # # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build -PAPER = +SOURCEDIR = . BUILDDIR = _build -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . - -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest - +# Put it first so that "make" without argument is like "make help". help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -clean: - -rm -rf $(BUILDDIR)/* +.PHONY: help Makefile -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Flask.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Flask.qhc" - -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/Flask" - @echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/Flask" - @echo "# devhelp" - -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ - "run these through (pdf)latex." - -latexpdf: latex - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex - @echo "Running LaTeX files through pdflatex..." - make -C _build/latex all-pdf - @echo "pdflatex finished; the PDF files are in _build/latex." - -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." +# 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/docs/_build/.ignore b/docs/_build/.ignore deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/_static/.ignore b/docs/_static/.ignore deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/_static/jinja-small.png b/docs/_static/jinja-logo-sidebar.png similarity index 100% rename from docs/_static/jinja-small.png rename to docs/_static/jinja-logo-sidebar.png diff --git a/docs/_static/jinja-logo.png b/docs/_static/jinja-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..7f8ca5bbde1ee0969678737896a2c19f0a7b073a GIT binary patch literal 12854 zcmcJ0^;cV8^koPR#jUs%*CNH;-D#jmC=LYz1b25SS}0a1Zb6C`2vCX^mln4`@!}4X z&v$12gPHroTUl8v@7;6mk^T1BiPP0q!NZ}#0RRAaYO0F*000U%^0O}%2J)&(Ho*V@ zyna+ulr!|TILgQNH5yoX?re3tpRYS{u9lTg>x=}T0GVQOHtS}|0`FQ{LTcUar5BZ) z-&PZ<_Bnyj$aolBYl}hO5?sC+nL!*^^mIvwyoc4vfnllJ4?Sz21trthay+xQ(~@qb zCngeh$HsER+IuD*f92(f(ci{q{(o3TeC&LDe4fi~?ybqR5?7&;_O`aRb9`vB`8c{# z_)ECXeb23O$;im)GG%{% z|F+ZTM7q~KFJ%}S#4_tl{ekTed-h!Uw`z_Z1NQZ`WAhi%>pRNk%C_R-&9B|vYZWTk zhp4};E0$7pTSGOiZ4pErLEzc8xzK3~5DUYcoGwSd7|{9q*aFE0?wz)$XVc8@-+yNp z79_rX`xf(Wz~#rOJ<~^3_4+y5FTCIUADx_>uD-Z_gH+ijHF_xBO|iRLtv7oIjaf3Tl1g-*5&@eFIEM+|8D)wZ%JESJTD9c>F%Gk{sH0oTV~NJGT|wIRdE2jGCFeS4+~f<$HB?TAh5!_zQ6 z9S>e_$>pr>vy(7YP5^bYQRSaQk1%67t>{#-!L+%e?whY0YYIjPKy@Tu@UWH<$u15O zm_sD_ez#89$;laNRzMGJ-Wta_jpHp!LUe!`7Wa<6kYu8On+^^gwt;!^}aUUrVeU_i`h8=+NzqN-C2cCK}B+a~1Uv8s*=^GJ}sc z0GOxCX=$|qk|zs~LX9IdOH@+mlG*pwL-(XX!h>H$eer)oDJ4(p-0_X8I-|%zU0k>| z!K{iX{p&@R8H1SV9v&Xj=)T)P)wOV*utzduROd(|Lhc(woy%f!w?s}N1+iN8T~3q2 zf+1kFk8Rl8#J2S1B5DAMH{LGku+XD<=rIK#hG=UrMFzESE#g;H?cnL|R2fzc-gDiL zTY*61tr@va+Tdvjw-c+wC7Rh-f=A2H-Ie11*$BJn-gHC0XWU^Z=9=+#<(bwpxs5UX}b&@EltnL>_lcF1se-^kouU zKMSkvRU)zQ_DSl|ejGQ<|1CM_Q5TJbrrJcTjGA(C5gQmN9Y2w9<7>I2rQ9~In@o*@ zZ=koc$9~dz^S~kfw&)=SoAKeE=Vkq{D-~wlHItN;Vba58sFq-_=Vlz6I3QQh@60CU zw9QphLj%o>BitDCECcRclo)X)eer+o;S`-07cYZK&+)wfx(=+tZV526C%x)$6}{s9 zQ0|P_5?`2^`jo=p5JtPrwhp78m(%_GF%>wa#+E2>L7{9tja47OM-#Se6~iw@R9& z?sjkTc9NLeS8IAuaWAXWy$*P)tE-o&;uP!B|GPgAY&~#m12Wa?jm_pb3|Gg@#OK1U z@(mS7WEi9go=19>yAo65zf;l;gw3%V7T8(+KzUnzsVtoMB2yM|r&P)9ii*k6JByurx7DKu#U#us>Ug{dsJO z1Tqjtz6)L9J+bASeFsNYMkZPBy@j98J?7@-zZ!BPT}GQG#5Evp#(f{@C67gSPwRtz z{Rur81};}O`m7y!XyvqaV%Udh*ZVZ8lY{tb&GtwU+oIPmX!j+94;#kmqX~TI+7AWn zUv~>OCdIuh;eG-S`LmRikb{EX`(UP4%~+L&lHnSc@q!zRrWu7?7Mmk^$l;q|Ttp5W z;0CaA^3mMtKx|g#%gQCLE#0Ho zbT|{OA!pqzB{rd#t<#o;0?h@wKa%29@Hpz_0sY$$! zwnY#S-YrlclWrIA4w5^%P7{)4`GKlKls2XKo;4qWns+`=DJZ$8^@d>Os|*!Qj`GWK zrDoRiuYLYFHHw+^I7cEY%w0(|P3gDn(03sX_7er=wks=I6z%pFWRTb*#cRS zzAEOF(N$x}55C(|wl>WgI9p+NYy&Z5fuCBxcf|<;FYFvV$Z!ow15M(d!Us}5{!6m zS@*9(&sF6cCauabOokvjujTNLmZ6RAuuZJ-XUsoj8L;WW8co==TxtIZ z8V9YqeV%*t)H1IVZQ_csw!b<4MVFZw zZ7;G14;kYTjkb!;5JXsI;?au>1W^`64%aq`Rf!?Ia9bd=mgTYrYCDiC8Z z02lPZGT7Vuak05MqAKVRLpsv+eE;Ht6G~Zq9?{ENO{K1`-o35-mab@aeqNyCvAdwV zvk|T?8>=pj3d%=SnHXei#akW0QUR*uL>e*a;f*Y%G#|0b=6lVXm~&g0sB5wfb`bxP zAVdcRWf_p>;+Ye7V*xD>=}DvI@d&6xz214ZG~IUJzhX#)7rVYdYuv?*c;D`QC`y#gcs%!AUfIz3st+oEnVw_njB`CyvG z)*}ZUh!>(@7Ut#it!4Ung~stf;g{pj^%+7dzZnTo_K|^W*svG7;ikaaaDbN4#O`w*k03Fk(W?6)}-Gb2dM13a~pN{%T!+ zys~VC1I88G?_0o<(M?{&gz#}gNWUpc0tR~d`MAV{HFty#C*>*Ot4LhA{sThgNRqHY z_Frf`l#Y7_bfhpSvL&4kv)6TLx3tS(!E&RpM$T;}9|h=tv=^ysfO9$`%^Ix%Nkkwl zO6g#0cGBGZ{Gio5-M@pk8~=DtNbbL5y>NxUWqW!*1qI|1yun=92f3EL8ZPm-Z z*SjJUNu=?s30_gOb)w(D_W51c{$&!EllJ(2xuc`wS7Y7O8xal}7BJDxMD6KcnR^lmvCX9*U6TvP4;Eh(SF_qX9iEahvt1AIoEBUs+5b@`Sa}t3} zi!g03=D9W`^1GA$F0C@kH^THv@3|V$wdc&(amP-xOJ)E?bn8C~OG$+q@i23bo3g=d zf=OU!<=T&m(lk~4G^5;zhVB`l8BB@bU(i`4}8=F*e3UBF&Oqml&jj# z%in)SYG^d)DghX_^M_ek^DX@SkLy0EYf-M#Ytv7k4{BbZiHl~2FKo=d2zqm8eIt_c zNVhwWM?K#yBq#`k3zgJeZ`<1rJbalOxcU+t11ZeSLIcim#Sql@3tu+{)i8sn$Ds%W zLT=dyzqxhv>a2T$TC5Qj&Y>W++9Sxr;~}#DtK&2b^T06|w>;5+{ZsV9me+!fop;SA z{x7xcBCT5+)UFQooIFP!Qp@$IuzV@uX8ZK-^r-rgNqJMe_AS+pFT`ON!$nRV;eq?* zKF_Zz?8ZKQOdSAbM;bGkD;Q*;gT!L_*+v3p7UC6|*5uI;IW?;Nrx5{Hhm@7&F(gK# zSP2q5V_Jlu*#|I8DNBwSD|>^EYGjYtiqWa!i{QvZbqs+F8ibrFXr;+{L3zW6Ys_us zy(IGwR}GzdK-(3+{L}%VMqW2u>}}bZt}$2eE9p4#ZUFyLhD&Mh?dO*q!w*uzK!4f? z2xGA1TF{;2gjax*!_3l|#S2w6@U0f%WkTHrc2NV^7C0x;eVX)%wHJZO(-klz-Vj{F zcQD=pGj~`+X>P(^k?Fn&7u>5p6VJYdP#3h+)YRyV2FzslQ5<^0c(hU<&V+@8_&fY9 zb{JvX%^1p{VSux{u`y-HZK=ZRa8OV$dYMNDz*&yHIp zVPx(%f%ajKcTPxdwFm2b&_x+-wwM%>Gfb(|{0|Rea?z?v*27DRUy+eH!W}U`-1zf( zOWYPGDAcq@W-SRL!d?6Ry8KRn;fZ$RyurNc|2|%c7uYmGn!K`cUVT<@fw_Teto!z@ zeV{ygxmfIZ0d_Jv4U~cbOkuMcOH?565Nec{bGw||ER@2$GI|-i_E=YmtPZ*KIJIs4 zux2)@y(oDepWU67gM{kalQop+R($&7<-AM;LtjGjWf9MKpDf%YYU{L^A9`SV*1u7H z>3@T*+i}_Yw{KYBcM{jw@Sl``gPcBDPqw(M9%Pj(OoP9trcE?fopW#cl(Q*H8nX73bBY9O%3W`XVb-jQ9*&@sB;kjkhZLjGl?H9 z))WxaPr&dXBtd$IUF4yg)$3lWXhNh)?Hl| zwLg-TLb>(*>1M0IAG&}+21|P_=8d3p0~m^ep7{c$2|5FoiISas&Ho5*zs_-Gz=17d z@w;SOiu*KfqKHl`*wR(O`3blj!L~MI=nzSK(xi^{#AsxQCv2$=guyLxEGbJq3daiV z^gD(;N6?ERmRc%3-fKI9NU`mSQoBRAnbma5^w!Qd4xyQeq_B%)u%%r1g3*>q1UBgAeLewu7i$kh$dxhTuT$n&i6VG-U?LbU zFIK>&*1UV%R)V3IH5m5N>(O(LQ%5XxSHl0PwZN}z(++xX6HL`vJ;1CY?#$c1&0irD z6OYY}bJR(?QcbRG*!V#?RH+xd%x2ZpztQxPZ1^Ei7e*t6^GAA)Y`NWYm%@m00grMT zVM`MFXEby5ZOFhkA4~te6~s(=>oO%4bm;D%;~tJ;!HtCQXyD50+1Foq&x_K~$U7r~ z(6MPjIHo~H*@oDbRnL9d&Rk5DsH}s%?No#A(!A#!EU4TvOWl4=s4-UnD>8OgX@Pbh3MwtMzLr#u+hkcer&9^86lS8=tH1K z+lv)(6Fztq#v8S)bk0X{nkSqmS1*rFJ8z2iPUp=0n7N=!5pX42OawXzvN(8faNwg> z{$(ROOG9ov%Ma@AVXG51pq7WLz)0}H7%gJ_AmlEctxJd(#dI6B=HX>$CM!pU=j z26XPnJ>*HghoRu&2e8mYrjtpHAL2I;9vwrXzvVT*L^sw>F4vT){@uM|0#NygZ~g-8 z67b}w4jCbn#)ZX$WgVv zMuFK42kJw9U?@}FQOKBp-DTSdiE^NS2OxAa!Jug;W+Ho(Cwu`J9v1k>*n``6XPRv% z{wm{)#xLxsWUirc*R)&89CDo;k2YyxVc}(3VHWE10Rw1Mn3XHV^~4%&90=_7R)rX3 zCi*L=Mwd>6XghMe{Os(kF2?K6qn;xSP+eDd{8IGb-Hno4s&>s7?G2)%*KOpXV<%cZ z=}fPEO%fR)2IfbkFGB|^H1IP%*L0Wtg|x^8GT#RG#4Zv$+_*Xgh|7l3jZU8&%_^%Xk=qbq)jX> z-2%NbT_={&=ly8SSxplGgLphI(Of z_(2cci!z0=B|$}kPJW@Ms86>(3F_9Y!Ceq-*p49ZCfnKZKRfHrv50E1pP=jRK8R3# zmBu=nP-Nzv&Hh+W$}4+3$?>f(SNk{O0H*8j7fyzY?lh99L6!+(%zyFYv4zq>{}(|#>@u8y6@$1dxiq$q!Hrm zn((TNoS4kQ^m7i;6ilr1b;*FLDoq3w`Q7u!l)y2x44Gn!#L%i2ox*L1S2#6)CE2s= zIW5bK;OU0q%Arw^41lxYIUJ}y+puD771{&K?T={$^a#%*Q# z^-k52!1=vJSAmLr=-k|Y*oZCsbnJ+3Jk^#MRu7FDDpl&{eLnrlnH(KRUxy@71pQh&f2xY;>$yWw62eKwLzNcRI6yh85*4UuEn~Xc zV~%+22cwV&F_?f^IXU1Db}HoLQh~itB82XTm*t?B+hnIJw*qEnIGNmlGa7J@73SO%*&E?E<7izrWOAOg1UD5xqln$LV6DsT!#gn69`_%wLviYQd+2A_f8NpcQv z`IphWo{6x^X3uq3YrEB2^j5O-M_UeS(izwqhN*#S?qOo5(ez;82n znfW-B4K_(v=XjxsGPzXI&pFjnF8>$fDZJ;3b?{nnyAsis$w82hWBGT%=oS)6PU-hA zq3{JPa1i!liMtcw8)o~rQK|gxS1eG4Wl~_9thLSHd7C{O4EOis^E25B165a@sZOp}6k=LDKGV%Mp5z!8zG| zV^tH8TyvxOJXfJ-8Q+4bSNrf$mn1mF3CuAic1iL2)qag;_K>MOI-vcTthn@zfjSD+Tc)PM#!Y`sOk$lwY?c$2P>#wl8g~xsoQDs-`Hw=^TSSUIq~HjW=bSp%#!rEQ zW)D}Pcm#qlx5YdE@_n-smwN$zWE(j>Y|+Jvsj95t&)h;Gr)i!d*`uXS3e`ugf%vxO zF;xGAK??1+sOHKlGRV=hHaOVNJ^2gZ`U|~5L9w3e7Y~6w%nLNqP5{={UXB+S)OtM> zfC{%W3#Yj&G9M>|v5@&O#gl6w=zZAbNA2>t&Zs!?T42_4tz20NDU7sv`LvY6R@{6{ zLD$@OBTDa_i+X+O=a~(3z&ey@u!b(nFTUhrlMy@YMRJT(QipNJaV?(qDloH_Sj;fCI`2Esx!dWpEG_63L{6ArL27i%NRmR{Y@$&hjK@zM9!saacFS3_xRBgqP-8T0MeymNu%=-@6ps(0@6 zoo>6+q<_dXs6Zwr3OFxF1SuGR>`NVUhRK+qGA#B?B%h8%K?5Bj^Vi0`)Ej1LFWlyi=ayWVPfd*_aQj%~X~EiCeOOrfTvpMw{d?0R)` z_mNn!IC;oiyXT|czWW(>tEs6`#O|)DyrQ{;`UWpo#C@#{TNorw|7hM#pPMD`l?cEee zD!w%LKA)x4E4xNF_P!dr?Jct38+i{HZ5A3t;}*5dL5r8DWi)~>a)_KKD8G`{NWBq( zOS!^@vjlsvL3%J|<$P zdg$BnN>mMLp2P8iV9n3!# z2KgP;@$vBuH)$@YvR6ODjT976cV8JneDroS&_JXeZ1xaBi!$aPFV&DNn;Ht&%e+Q* z!iwy10~##RcOotV|7DE5$7s81C6K(8-9pGpK0okdBt0@?{C=tbHgP4&<2VV6aD1Ub zQ7F!v|EAWZ#Hw@Ww(Ue>)&Ib9*%$c~#b9{+ct0nfjDMIC2Y8shTH?NAlr6d$#8+ID zvktcwFM3sRv4>kW#7SQB3U=|A6Bz>88@M-(YlFx69KdP374hTYC*FKngbpc)w60-z zR`}H?o5)NdSl`CE+xW=Yp&g8gYt-*@N<|CVUW_(T)Cs}{C_Xc}Nl(wM3b>fY1PZ25 zeKkg$4gw)=igy%k6Q4NQ*6dlO!`|}yH}k>R0Y7FCWklS0squGRu|0b%0+y19^70V7 z0+iwpI(}+#=<~jj-&nycRJJU40yx+_x!CxUW&LW(hAUx4OjAajVd&+)$=0u?iAsCp z_BTj%kXjM1Ki>o>!6>noy{C@?wT}EbS)?%eFI?I7cK&bLwltVTqpjHoQEPyTAi5%& zrKZ>1%WENk*(u&D&IfZuw9k|yHZN>)Zs)FtbGzLltDmA0I8uNI$mwx7{QU{u*HxKC zK;n=HYvZR`u>C=E-kYWtT#XyAoDB7LS@OQ9WtnB^jB+YwtD#(Z!&_4Mvw;&t3ozCS zoodk1BiG8b7oas2@>;If7Q*H*DHEVI#sT3N3)Bixnorr}r;!1ml7ZX8il#r!DVEFq z4s*vo`c>K>U(@p5!%raM%3fty2|r&`E415zqxyS*d6Mu=T;>803~rc=4JzawJbc=9k6LTf@rXo8~6$T$wFUuR4iHe+4hWi&c@+a`QY9@TMs5{Q6nLl%|ihB z)1yHkZ`3K7$!Dul*c)Xwv@Coc8T(y#N|)PGqfI|4ssyr+IZVhhrI>2=o+R~_eMid+ zTG||Rf2Fg9`wYmlOOXzqo1BCZ3~GSOhb7gAfeCyMkr6_Icvex+Zysk~1Pmgh90nXx zmZ9lQtN-4kb@w@KT`sU0YQJXk7GtNQomH0dwaD6N5oCq2Uq7w(JbX=G)FL8hYh~&a z)7hCBVDkW^*n9g6^-L6X63f2*E-od-bbc1+K-2*h+1-AS-#Il1HlBa2At11G&huwf zKrjjSOEy!V|JE?uJDb%KZK!_NyO$G=8xJIeenvSR(ZPOxW+zP357V5d-{XH?RE%Ye z6BtLbceJ}W6uN5_0m-d0hdjO>vlGXeVGe$P?7q$H!={@Vtky)%kV!|nY4wb`@|wTe z++Ps|M+}=Ca*bX#Vb*ocx3BS&9{FVpL!SQdQ$9Sn0pmmOG$8g9&3A;uE@JYO&KJ^HF56QA2u zvRvuMWe8x2S2#p1=D*gH9dR1$nCWYwWZh6KVASF`7XPzBw0YvjdGI@qu?h}|wEJcT zyacF9*cMCgK;=%3*m$rrV;-}m%Zp*@xiFLNdn~kR4{kX=8_majQGZ)(y<+8i-ZV^} zj06GV7Y|Ogg__melwh(b`Jd&Ho(f;u;3EVWJ@L?jg}|ws3|Qbo9dV8dMKI}`S}hGh z`2^4Mwx}1D=|8jK;|6^C18kNxI3Tgs(sGrVzs`&&@)sk}v!p+0r zeQiPA$@tyoWd&TlQP&v*g`V%?hNNx(bBJ^wZ{?B)FDlffiC)D{cHi4bt7B%Fs&LF) zL?LZ47qPRoC4Witaecjd!WL=7{`d3Z`tNB7Lc-D0>#RL3<4E38vph{fFRe@@;{pH| z9?HKC-=b2@G2R#HT|Wf`B-KzSNt9*<|C6g6E5ThEp2{13?qpPu)X`5DR*n;~w`*Zo zTpWoyIFr1dG!^u;Gs7bAM`DEmPgB5wm#9y5pp)wPXtjcp+$djd8Zaw<_<3+622`a{-yR4twp&$Ec!rjbR{^ENG*(ybicmfq%D=X5J=@9w$nATD?MSwwV z&F6PA6V1_}{p03n!?-CuJ^q`p?>a(#9mO@=j9`v0-(SG(-T*Fq6xEh@IdSM*%dq&5 zd%v}e6JS_I^T>7#oBib;)!j^q{mvIi%soTvr4QHtFP0_iSu@lfZV?Fgpl;(D4nlRw z`V@^@IeafygNP^2s%a}Sg0DEnc|r%-b**zG;8RD^ysy|j$CzJ9>PChtezq5mNDgxv z!QbC;9?e~icwbLf&;IdJ{@SFq%GR?&+J0Dn1F9%wZ)MGA>PR}N2t4uS36V%8RmQ`B(Lri4SJf9 zCaKs2`~6Izf2OclBQQSQFC`BmAO|yscbvC0H}7g{$MTK@YiDKnrOhz_=iLasy4g<1 zEM+@=`_OP}p4k5*NClF3^PaaNu}L~)HNr;u>Va8}AOnUBUyGEXhqHAMW9W<((C9nm zAr1&B0x%Hw*H}R}hVFQaj){EpWmTx77r&4VX1}1wDVLz)hUcc|cX=PdtZdIL+#wGw zO%pBf{gmSL9j1r567C#jit&)of-4B7JrD_>pBW0vDv1(H!CRu7{o|ao_21k8`yMnS zCc)o+X1z}Q09>N}iEJBN%0ho09JGp&ffVBy+N&TJsulyU0F701D*7|ImY$nb%veaQl8X zXBkBJ{LKHhVWV#R zG>+kI^U4J?B?7b_7zg}e>X;mh4HSrZ`2JKh>l`^cSCFZSr9$C6(|<tA z`k%B>hy(`758~G8`!$Q0VJwYMkI9sFkxP18=~@JA2+b_l?&46EgM3Psn2=fXvsw{H zYDTj9`FMh!lSI6CcDECAkmFxL5z>xI{+EH2FmV_YbBWS%Y|#f7(?xtm;u8oLnP2U( zQxPhcxR@a6-M=TKyejds7I7!-W7UdoEThj2_M$M23)jd&B2d;Z+nDS!sspH*k(o}` zOxC_CriY6>bi!5n8gJT~cKh=3{&sZ!Mf*X-oL3Bn$S_6REkzT!ArhTt?*CBTQ?D{ew;wd+ z)l(`o7y269`mZW63HGroH5Zmf2%=U~si)PprirBSwsC@w%c1uE9ZjzYe~&KA^wX&g ze7FKp#lk%bapsZim>4aAc|h&V?@5NGCXFoSfuN<2$Crkmu|aclbH4=4 z;}8A*)CF^hSD=8%Ae(9ewP|QkXxW7`2fBLZDmlt=yU;ckpcqMo;q^oY!62Q2#Pyzz zn%17b!Lj<|juKnmWQ)h5kp1iZCc;ZoUJ%c}!br?ek1}Jv=Pv^I2L@|QKOJWH4Z2ihmb1&o7ve3}C25tj? zl8R=z%dCb?tr=;T^8Bju16(6->rDr@kqI?SAWX9nP6dYpWAWE-^mDR`XJ&4{H7i3X z&w_N4eR8Hb)Y>={DDgzET@3tb^{FZ{js_cmIfIklEhQQq-KprtCnG>-Flqw+lS)oj zxL`fQCr!T#4nhHX@Tm`anyHBq+U)GXA$Aq^c$&c?V}dKfZL~ zTbQ|w`cK6yg+f04Vc_w%R4Sf}uX#(gCC>Ptx;!&65j=23y5qU{V7(~|RFn0bl`Csw z=9^&Fgf*+`9_#t(vn>@x8`^tl$WeD1(vB)Nc;mhj3RdCR`SJUIbkYRc`Qn!(0zqzS zKy}PCv=sFdOinydj166cdyR8$K^>n>*c?)mMzzi~^zZbw-}hDAbout Jinja2 -

- Jinja2 is a full featured template engine for Python. It has full unicode - support, an optional integrated sandboxed execution environment, widely used - and BSD licensed. -

-

Other Formats

-

- You can download the documentation in other formats as well: -

- -

Useful Links

- diff --git a/docs/_templates/sidebarlogo.html b/docs/_templates/sidebarlogo.html deleted file mode 100644 index ca211c6a..00000000 --- a/docs/_templates/sidebarlogo.html +++ /dev/null @@ -1,3 +0,0 @@ - diff --git a/docs/_themes/LICENSE b/docs/_themes/LICENSE deleted file mode 100644 index 8daab7ee..00000000 --- a/docs/_themes/LICENSE +++ /dev/null @@ -1,37 +0,0 @@ -Copyright (c) 2010 by Armin Ronacher. - -Some rights reserved. - -Redistribution and use in source and binary forms of the theme, with or -without modification, are permitted provided that the following conditions -are met: - -* Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - -* Redistributions in binary form must reproduce the above - copyright notice, this list of conditions and the following - disclaimer in the documentation and/or other materials provided - with the distribution. - -* The names of the contributors may not be used to endorse or - promote products derived from this software without specific - prior written permission. - -We kindly ask you to only use these themes in an unmodified manner just -for Flask and Flask-related products, not for unrelated projects. If you -like the visual style and want to use it for your own projects, please -consider making some larger changes to the themes (such as changing -font faces, sizes, colors or margins). - -THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE -ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE -LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF -SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS -INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN -CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) -ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE -POSSIBILITY OF SUCH DAMAGE. diff --git a/docs/_themes/README b/docs/_themes/README deleted file mode 100644 index b3292bdf..00000000 --- a/docs/_themes/README +++ /dev/null @@ -1,31 +0,0 @@ -Flask Sphinx Styles -=================== - -This repository contains sphinx styles for Flask and Flask related -projects. To use this style in your Sphinx documentation, follow -this guide: - -1. put this folder as _themes into your docs folder. Alternatively - you can also use git submodules to check out the contents there. -2. add this to your conf.py: - - sys.path.append(os.path.abspath('_themes')) - html_theme_path = ['_themes'] - html_theme = 'flask' - -The following themes exist: - -- 'flask' - the standard flask documentation theme for large - projects -- 'flask_small' - small one-page theme. Intended to be used by - very small addon libraries for flask. - -The following options exist for the flask_small theme: - - [options] - index_logo = '' filename of a picture in _static - to be used as replacement for the - h1 in the index.rst file. - index_logo_height = 120px height of the index logo - github_fork = '' repository name on github for the - "fork me" badge diff --git a/docs/_themes/jinja/layout.html b/docs/_themes/jinja/layout.html deleted file mode 100644 index a0c9cab0..00000000 --- a/docs/_themes/jinja/layout.html +++ /dev/null @@ -1,8 +0,0 @@ -{%- extends "basic/layout.html" %} -{%- block relbar2 %}{% endblock %} -{%- block footer %} -
- © Copyright {{ copyright }}. - Created using Sphinx. -
-{%- endblock %} diff --git a/docs/_themes/jinja/relations.html b/docs/_themes/jinja/relations.html deleted file mode 100644 index 3bbcde85..00000000 --- a/docs/_themes/jinja/relations.html +++ /dev/null @@ -1,19 +0,0 @@ -

Related Topics

- diff --git a/docs/_themes/jinja/static/jinja.css_t b/docs/_themes/jinja/static/jinja.css_t deleted file mode 100644 index 3291ba6f..00000000 --- a/docs/_themes/jinja/static/jinja.css_t +++ /dev/null @@ -1,396 +0,0 @@ -/* - * jinja.css_t - * ~~~~~~~~~~~ - * - * :copyright: Copyright 2011 by Armin Ronacher. - * :license: Flask Design License, see LICENSE for details. - */ - -@import url(http://fonts.googleapis.com/css?family=Crimson+Text); - -{% set page_width = '940px' %} -{% set sidebar_width = '220px' %} -{% set font_family = 'Georgia, serif' %} -{% set header_font_family = 'Crimson Text, ' ~ font_family %} - -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: {{ font_family }}; - font-size: 17px; - background-color: white; - color: #000; - margin: 0; - padding: 0; -} - -div.document { - width: {{ page_width }}; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 {{ sidebar_width }}; -} - -div.sphinxsidebar { - width: {{ sidebar_width }}; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #ffffff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -img.floatingflask { - padding: 0 0 10px 10px; - float: right; -} - -div.footer { - width: {{ page_width }}; - margin: 20px auto 30px auto; - font-size: 14px; - color: #888; - text-align: right; -} - -div.footer a { - color: #888; -} - -div.related { - display: none; -} - -div.sphinxsidebar a { - color: #444; - text-decoration: none; - border-bottom: 1px dotted #999; -} - -div.sphinxsidebar a:hover { - border-bottom: 1px solid #999; -} - -div.sphinxsidebar { - font-size: 15px; - line-height: 1.5; -} - -div.sphinxsidebarwrapper { - padding: 18px 10px; -} - -div.sphinxsidebarwrapper p.logo { - padding: 0 0 20px 0; - margin: 0; - text-align: center; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: {{ font_family }}; - color: #444; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 20px; -} - -div.sphinxsidebar h3 a { - color: #444; -} - -div.sphinxsidebar p.logo a, -div.sphinxsidebar h3 a, -div.sphinxsidebar p.logo a:hover, -div.sphinxsidebar h3 a:hover { - border: none; -} - -div.sphinxsidebar p { - color: #555; - margin: 10px 0; -} - -div.sphinxsidebar ul { - margin: 10px 0; - padding: 0; - color: #000; -} - -div.sphinxsidebar input { - border: 1px solid #ccc; - font-family: {{ font_family }}; - font-size: 14px; -} - -div.sphinxsidebar form.search input[name="q"] { - width: 130px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #aa0000; - text-decoration: underline; -} - -a:hover { - color: #dd0000; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: {{ header_font_family }}; - font-weight: normal; - margin: 30px 0px 10px 0px; - padding: 0; - color: black; -} - -div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 150%; } -div.body h4 { font-size: 130%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #ddd; - padding: 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - color: #444; - background: #eaeaea; -} - -div.body p, div.body dd, div.body li { - line-height: 1.4em; -} - -div.admonition { - background: #fafafa; - margin: 20px -30px; - padding: 10px 30px; - border-top: 1px solid #ccc; - border-bottom: 1px solid #ccc; -} - -div.admonition tt.xref, div.admonition a tt { - border-bottom: 1px solid #fafafa; -} - -dd div.admonition { - margin-left: -60px; - padding-left: 60px; -} - -div.admonition p.admonition-title { - font-family: {{ font_family }}; - font-weight: normal; - font-size: 24px; - margin: 0 0 10px 0; - padding: 0; - line-height: 1; -} - -div.admonition p.last { - margin-bottom: 0; -} - -div.highlight { - background-color: white; -} - -dt:target, .highlight { - background: #FAF3E8; -} - -div.note { - background-color: #eee; - border: 1px solid #ccc; -} - -div.seealso { - background-color: #ffc; - border: 1px solid #ff6; -} - -div.topic { - background-color: #eee; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre, tt { - font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.85em; -} - -img.screenshot { -} - -tt.descname, tt.descclassname { - font-size: 0.95em; -} - -tt.descname { - padding-right: 0.08em; -} - -img.screenshot { - -moz-box-shadow: 2px 2px 4px #eee; - -webkit-box-shadow: 2px 2px 4px #eee; - box-shadow: 2px 2px 4px #eee; -} - -table.docutils { - border: 1px solid #888; - -moz-box-shadow: 2px 2px 4px #eee; - -webkit-box-shadow: 2px 2px 4px #eee; - box-shadow: 2px 2px 4px #eee; -} - -table.docutils td, table.docutils th { - border: 1px solid #888; - padding: 0.25em 0.7em; -} - -table.field-list, table.footnote { - border: none; - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - -table.footnote { - margin: 15px 0; - width: 100%; - border: 1px solid #eee; - background: #fdfdfd; - font-size: 0.9em; -} - -table.footnote + table.footnote { - margin-top: -15px; - border-top: none; -} - -table.field-list th { - padding: 0 0.8em 0 0; -} - -table.field-list td { - padding: 0; -} - -table.footnote td.label { - width: 0px; - padding: 0.3em 0 0.3em 0.5em; -} - -table.footnote td { - padding: 0.3em 0.5em; -} - -dl { - margin: 0; - padding: 0; -} - -dl dd { - margin-left: 30px; -} - -blockquote { - margin: 0 0 0 30px; - padding: 0; -} - -ul, ol { - margin: 10px 0 10px 30px; - padding: 0; -} - -pre { - background: #eee; - padding: 7px 30px; - margin: 15px -30px; - line-height: 1.3em; -} - -dl pre, blockquote pre, li pre { - margin-left: -60px; - padding-left: 60px; -} - -dl dl pre { - margin-left: -90px; - padding-left: 90px; -} - -tt { - background-color: #E8EFF0; - color: #222; - /* padding: 1px 2px; */ -} - -tt.xref, a tt { - background-color: #E8EFF0; - border-bottom: 1px solid white; -} - -a.reference { - text-decoration: none; - border-bottom: 1px dotted #bb0000; -} - -a.reference:hover { - border-bottom: 1px solid #dd0000; -} - -a.footnote-reference { - text-decoration: none; - font-size: 0.7em; - vertical-align: top; - border-bottom: 1px dotted #bb0000; -} - -a.footnote-reference:hover { - border-bottom: 1px solid #dd0000; -} - -a:hover tt { - background: #EEE; -} diff --git a/docs/_themes/jinja/theme.conf b/docs/_themes/jinja/theme.conf deleted file mode 100644 index 10c7e56e..00000000 --- a/docs/_themes/jinja/theme.conf +++ /dev/null @@ -1,3 +0,0 @@ -[theme] -inherit = basic -stylesheet = jinja.css diff --git a/docs/api.rst b/docs/api.rst index bbe6c366..fdd508d3 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -19,7 +19,7 @@ Even if you are creating templates from strings by using the constructor of albeit a shared one. Most applications will create one :class:`Environment` object on application -initialization and use that to load templates. In some cases however, it's +initialization and use that to load templates. In some cases however, it's useful to have multiple environments side by side, if different configurations are in use. @@ -213,7 +213,7 @@ useful if you want to dig deeper into Jinja2 or :ref:`develop extensions For a more complex example you can provide a hint. For example the :func:`first` filter creates an undefined object that way:: - return environment.undefined('no first item, sequence was empty') + return environment.undefined('no first item, sequence was empty') If it the `name` or `obj` is known (for example because an attribute was accessed) it should be passed to the undefined object, even if @@ -829,7 +829,7 @@ Here a simple test that checks if a variable is a prime number:: if n % i == 0: return False return True - + You can register it on the template environment by updating the :attr:`~Environment.tests` dict on the environment:: diff --git a/docs/cache_extension.py b/docs/cache_extension.py index ccdefa2f..992b5951 100644 --- a/docs/cache_extension.py +++ b/docs/cache_extension.py @@ -4,7 +4,7 @@ from jinja2.ext import Extension class FragmentCacheExtension(Extension): # a set of names that trigger the extension. - tags = set(['cache']) + tags = {'cache'} def __init__(self, environment): super(FragmentCacheExtension, self).__init__(environment) diff --git a/docs/changelog.rst b/docs/changelog.rst index 9f114842..218fe333 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -1,3 +1,4 @@ -.. module:: jinja2 +Changelog +========= -.. include:: ../CHANGES +.. include:: ../CHANGES.rst diff --git a/docs/conf.py b/docs/conf.py index 6e990be1..01e530dc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,160 +1,52 @@ -# -*- coding: utf-8 -*- -# -# Jinja2 documentation build configuration file, created by -# sphinx-quickstart on Sun Apr 27 21:42:41 2008. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed automatically). -# -# All configuration values have a default value; values that are commented out -# serve to show the default value. +from pallets_sphinx_themes import get_version +from pallets_sphinx_themes import ProjectLink -import sys, os +# Project -------------------------------------------------------------- -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -sys.path.append(os.path.dirname(os.path.abspath(__file__))) +project = "Jinja" +copyright = "2007 Pallets" +author = "Pallets" +release, version = get_version("Jinja2") -# General configuration -# --------------------- +# General -------------------------------------------------------------- -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'jinjaext'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General substitutions. -project = 'Jinja2' -copyright = '2008, Armin Ronacher' - -# The default replacements for |version| and |release|, also used in various -# other places throughout the built documents. -# -# The short X.Y version. -import pkg_resources -try: - release = pkg_resources.get_distribution('Jinja2').version -except ImportError: - print 'To build the documentation, The distribution information of Jinja2' - print 'Has to be available. Either install the package into your' - print 'development environment or run "setup.py develop" to setup the' - print 'metadata. A virtualenv is recommended!' - sys.exit(1) -if 'dev' in release: - release = release.split('dev')[0] + 'dev' -version = '.'.join(release.split('.')[:2]) - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'jinjaext.JinjaStyle' - - -# Options for HTML output -# ----------------------- - -html_theme = 'jinja' -html_theme_path = ['_themes'] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# 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'] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# no modindex -html_use_modindex = False - -# If true, the reST sources are included in the HTML build as _sources/. -#html_copy_source = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. -#html_use_opensearch = False - -# Output file base name for HTML help builder. -htmlhelp_basename = 'Jinja2doc' - - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -latex_paper_size = 'a4' - -# The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class [howto/manual]). -latex_documents = [ - ('latexindex', 'Jinja2.tex', 'Jinja2 Documentation', 'Armin Ronacher', - 'manual'), +master_doc = "index" +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "pallets_sphinx_themes", + "sphinxcontrib.log_cabinet", + "sphinx_issues", ] +intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)} +issues_github_path = "pallets/jinja" -# Additional stuff for LaTeX -latex_elements = { - 'fontpkg': r'\usepackage{mathpazo}', - 'papersize': 'a4paper', - 'pointsize': '12pt', - 'preamble': r''' -\usepackage{jinjastyle} +# HTML ----------------------------------------------------------------- -% i hate you latex -\DeclareUnicodeCharacter{14D}{o} -''' +html_theme = "jinja" +html_theme_options = {"index_sidebar_logo": False} +html_context = { + "project_links": [ + ProjectLink("Donate to Pallets", "https://palletsprojects.com/donate"), + ProjectLink("Jinja Website", "https://palletsprojects.com/p/jinja/"), + ProjectLink("PyPI releases", "https://pypi.org/project/Jinja2/"), + ProjectLink("Source Code", "https://github.com/pallets/jinja/"), + ProjectLink("Issue Tracker", "https://github.com/pallets/jinja/issues/"), + ] } - -latex_use_parts = True - -latex_additional_files = ['jinjastyle.sty', 'logo.pdf'] - -# If false, no module index is generated. -latex_use_modindex = False - html_sidebars = { - 'index': ['sidebarlogo.html', 'sidebarintro.html', 'sourcelink.html', - 'searchbox.html'], - '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html', - 'sourcelink.html', 'searchbox.html'] + "index": ["project.html", "localtoc.html", "searchbox.html"], + "**": ["localtoc.html", "relations.html", "searchbox.html"], } +singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]} +html_static_path = ["_static"] +html_favicon = "_static/jinja-logo-sidebar.png" +html_logo = "_static/jinja-logo-sidebar.png" +html_title = "Jinja Documentation ({})".format(version) +html_show_sourcelink = False + +# LaTeX ---------------------------------------------------------------- + +latex_documents = [ + (master_doc, "Jinja-{}.tex".format(version), html_title, author, "manual") +] diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc deleted file mode 100644 index 7ee68703..00000000 --- a/docs/contents.rst.inc +++ /dev/null @@ -1,23 +0,0 @@ -Jinja2 Documentation --------------------- - -.. toctree:: - :maxdepth: 2 - - intro - api - sandbox - templates - extensions - integration - switching - tricks - -Additional Information ----------------------- - -.. toctree:: - :maxdepth: 2 - - faq - changelog diff --git a/docs/extensions.rst b/docs/extensions.rst index 635d1e4c..43ee2e27 100644 --- a/docs/extensions.rst +++ b/docs/extensions.rst @@ -27,8 +27,8 @@ i18n Extension **Import name:** `jinja2.ext.i18n` -The i18n extension can be used in combination with `gettext`_ or `babel`_. If -the i18n extension is enabled Jinja2 provides a `trans` statement that marks +The i18n extension can be used in combination with `gettext`_ or `babel`_. If +the i18n extension is enabled Jinja2 provides a `trans` statement that marks the wrapped string as translatable and calls `gettext`. After enabling, dummy `_` function that forwards calls to `gettext` is added @@ -294,7 +294,7 @@ extensions: The current :class:`~jinja2.lexer.TokenStream` .. autoclass:: jinja2.lexer.TokenStream - :members: push, look, eos, skip, next, next_if, skip_if, expect + :members: push, look, eos, skip, __next__, next_if, skip_if, expect .. attribute:: current @@ -336,6 +336,6 @@ For more information have a look at the repr of :meth:`jinja2.Environment.parse` .. module:: jinja2.nodes -.. jinjanodes:: +.. jinja:nodes:: jinja2.nodes.Node .. autoexception:: Impossible diff --git a/docs/index.rst b/docs/index.rst index a08d6281..616e5bf3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,13 @@ -Welcome to Jinja2 -================= +.. rst-class:: hide-header -Jinja2 is a modern and designer-friendly templating language for Python, +Jinja +===== + +.. image:: _static/jinja-logo.png + :align: center + :target: https://palletsprojects.com/p/jinja/ + +Jinja is a modern and designer-friendly templating language for Python, modelled after Django's templates. It is fast, widely used and secure with the optional sandboxed template execution environment: @@ -14,7 +20,7 @@ with the optional sandboxed template execution environment: {% endfor %} -**Features:** +Features: - sandboxed execution - powerful automatic HTML escaping system for XSS prevention @@ -25,10 +31,20 @@ with the optional sandboxed template execution environment: the correct line in the template. - configurable syntax -.. include:: contents.rst.inc +.. toctree:: + :maxdepth: 2 + :caption: Contents: -If you can't find the information you're looking for, have a look at the -index or try to find it using the search function: + intro + api + sandbox + templates + extensions + integration + switching + tricks + faq + changelog * :ref:`genindex` * :ref:`search` diff --git a/docs/jinjaext.py b/docs/jinjaext.py deleted file mode 100644 index cdacba9d..00000000 --- a/docs/jinjaext.py +++ /dev/null @@ -1,194 +0,0 @@ -# -*- coding: utf-8 -*- -""" - Jinja Documentation Extensions - ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - Support for automatically documenting filters and tests. - - :copyright: Copyright 2008 by Armin Ronacher. - :license: BSD. -""" -import collections -import os -import re -import inspect -import jinja2 -from itertools import islice -from types import BuiltinFunctionType -from docutils import nodes -from docutils.statemachine import ViewList -from sphinx.ext.autodoc import prepare_docstring -from sphinx.application import TemplateBridge -from pygments.style import Style -from pygments.token import Keyword, Name, Comment, String, Error, \ - Number, Operator, Generic -from jinja2 import Environment, FileSystemLoader - - -def parse_rst(state, content_offset, doc): - node = nodes.section() - # hack around title style bookkeeping - surrounding_title_styles = state.memo.title_styles - surrounding_section_level = state.memo.section_level - state.memo.title_styles = [] - state.memo.section_level = 0 - state.nested_parse(doc, content_offset, node, match_titles=1) - state.memo.title_styles = surrounding_title_styles - state.memo.section_level = surrounding_section_level - return node.children - - -class JinjaStyle(Style): - title = 'Jinja Style' - default_style = "" - styles = { - Comment: 'italic #aaaaaa', - Comment.Preproc: 'noitalic #B11414', - Comment.Special: 'italic #505050', - - Keyword: 'bold #B80000', - Keyword.Type: '#808080', - - Operator.Word: 'bold #B80000', - - Name.Builtin: '#333333', - Name.Function: '#333333', - Name.Class: 'bold #333333', - Name.Namespace: 'bold #333333', - Name.Entity: 'bold #363636', - Name.Attribute: '#686868', - Name.Tag: 'bold #686868', - Name.Decorator: '#686868', - - String: '#AA891C', - Number: '#444444', - - Generic.Heading: 'bold #000080', - Generic.Subheading: 'bold #800080', - Generic.Deleted: '#aa0000', - Generic.Inserted: '#00aa00', - Generic.Error: '#aa0000', - Generic.Emph: 'italic', - Generic.Strong: 'bold', - Generic.Prompt: '#555555', - Generic.Output: '#888888', - Generic.Traceback: '#aa0000', - - Error: '#F00 bg:#FAA' - } - - -_sig_re = re.compile(r'^[a-zA-Z_][a-zA-Z0-9_]*(\(.*?\))') - - -def format_function(name, aliases, func): - lines = inspect.getdoc(func).splitlines() - signature = '()' - if isinstance(func, BuiltinFunctionType): - match = _sig_re.match(lines[0]) - if match is not None: - del lines[:1 + bool(lines and not lines[0])] - signature = match.group(1) - else: - try: - argspec = inspect.getargspec(func) - if getattr(func, 'environmentfilter', False) or \ - getattr(func, 'contextfilter', False) or \ - getattr(func, 'evalcontextfilter', False): - del argspec[0][0] - signature = inspect.formatargspec(*argspec) - except: - pass - result = ['.. function:: %s%s' % (name, signature), ''] - result.extend(' ' + line for line in lines) - if aliases: - result.extend(('', ' :aliases: %s' % ', '.join( - '``%s``' % x for x in sorted(aliases)))) - return result - - -def dump_functions(mapping): - def directive(dirname, arguments, options, content, lineno, - content_offset, block_text, state, state_machine): - reverse_mapping = {} - for name, func in mapping.items(): - reverse_mapping.setdefault(func, []).append(name) - filters = [] - for func, names in reverse_mapping.items(): - aliases = sorted(names, key=lambda x: len(x)) - name = aliases.pop() - filters.append((name, aliases, func)) - filters.sort() - - result = ViewList() - for name, aliases, func in filters: - for item in format_function(name, aliases, func): - result.append(item, '') - - node = nodes.paragraph() - state.nested_parse(result, content_offset, node) - return node.children - return directive - - -from jinja2.defaults import DEFAULT_FILTERS, DEFAULT_TESTS -jinja_filters = dump_functions(DEFAULT_FILTERS) -jinja_tests = dump_functions(DEFAULT_TESTS) - - -def jinja_nodes(dirname, arguments, options, content, lineno, - content_offset, block_text, state, state_machine): - from jinja2.nodes import Node - doc = ViewList() - def walk(node, indent): - p = ' ' * indent - sig = ', '.join(node.fields) - doc.append(p + '.. autoclass:: %s(%s)' % (node.__name__, sig), '') - if node.abstract: - members = [] - for key, name in node.__dict__.items(): - if not key.startswith('_') and \ - not hasattr(node.__base__, key) and isinstance(name, collections.Callable): - members.append(key) - if members: - members.sort() - doc.append('%s :members: %s' % (p, ', '.join(members)), '') - if node.__base__ != object: - doc.append('', '') - doc.append('%s :Node type: :class:`%s`' % - (p, node.__base__.__name__), '') - doc.append('', '') - children = node.__subclasses__() - children.sort(key=lambda x: x.__name__.lower()) - for child in children: - walk(child, indent) - walk(Node, 0) - return parse_rst(state, content_offset, doc) - - -def inject_toc(app, doctree, docname): - titleiter = iter(doctree.traverse(nodes.title)) - try: - # skip first title, we are not interested in that one - next(titleiter) - title = next(titleiter) - # and check if there is at least another title - next(titleiter) - except StopIteration: - return - tocnode = nodes.section('') - tocnode['classes'].append('toc') - toctitle = nodes.section('') - toctitle['classes'].append('toctitle') - toctitle.append(nodes.title(text='Table Of Contents')) - tocnode.append(toctitle) - tocnode += doctree.document.settings.env.get_toc_for(docname)[0][1] - title.parent.insert(title.parent.children.index(title), tocnode) - - -def setup(app): - app.add_directive('jinjafilters', jinja_filters, 0, (0, 0, 0)) - app.add_directive('jinjatests', jinja_tests, 0, (0, 0, 0)) - app.add_directive('jinjanodes', jinja_nodes, 0, (0, 0, 0)) - # uncomment for inline toc. links are broken unfortunately - ##app.connect('doctree-resolved', inject_toc) diff --git a/docs/jinjastyle.sty b/docs/jinjastyle.sty deleted file mode 100644 index da811ce3..00000000 --- a/docs/jinjastyle.sty +++ /dev/null @@ -1,119 +0,0 @@ -\definecolor{TitleColor}{rgb}{0,0,0} -\definecolor{InnerLinkColor}{rgb}{0,0,0} -\definecolor{OuterLinkColor}{rgb}{0.8,0,0} - -\renewcommand{\maketitle}{% - \begin{titlepage}% - \let\footnotesize\small - \let\footnoterule\relax - \ifsphinxpdfoutput - \begingroup - % This \def is required to deal with multi-line authors; it - % changes \\ to ', ' (comma-space), making it pass muster for - % generating document info in the PDF file. - \def\\{, } - \pdfinfo{ - /Author (\@author) - /Title (\@title) - } - \endgroup - \fi - \begin{flushright}% - %\sphinxlogo% - {\center - \vspace*{3cm} - \includegraphics{logo.pdf} - \vspace{3cm} - \par - {\rm\Huge \@title \par}% - {\em\LARGE \py@release\releaseinfo \par} - {\large - \@date \par - \py@authoraddress \par - }}% - \end{flushright}%\par - \@thanks - \end{titlepage}% - \cleardoublepage% - \setcounter{footnote}{0}% - \let\thanks\relax\let\maketitle\relax - %\gdef\@thanks{}\gdef\@author{}\gdef\@title{} -} - -\fancypagestyle{normal}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\thepage}} - \fancyfoot[LO]{{\nouppercase{\rightmark}}} - \fancyfoot[RE]{{\nouppercase{\leftmark}}} - \fancyhead[LE,RO]{{ \@title, \py@release}} - \renewcommand{\headrulewidth}{0.4pt} - \renewcommand{\footrulewidth}{0.4pt} -} - -\fancypagestyle{plain}{ - \fancyhf{} - \fancyfoot[LE,RO]{{\thepage}} - \renewcommand{\headrulewidth}{0pt} - \renewcommand{\footrulewidth}{0.4pt} -} - -\titleformat{\section}{\Large}% - {\py@TitleColor\thesection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsection}{\large}% - {\py@TitleColor\thesubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\subsubsection}{}% - {\py@TitleColor\thesubsubsection}{0.5em}{\py@TitleColor}{\py@NormalColor} -\titleformat{\paragraph}{\large}% - {\py@TitleColor}{0em}{\py@TitleColor}{\py@NormalColor} - -\ChNameVar{\raggedleft\normalsize} -\ChNumVar{\raggedleft \bfseries\Large} -\ChTitleVar{\raggedleft \rm\Huge} - -\renewcommand\thepart{\@Roman\c@part} -\renewcommand\part{% - \pagestyle{plain} - \if@noskipsec \leavevmode \fi - \cleardoublepage - \vspace*{6cm}% - \@afterindentfalse - \secdef\@part\@spart} - -\def\@part[#1]#2{% - \ifnum \c@secnumdepth >\m@ne - \refstepcounter{part}% - \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}% - \else - \addcontentsline{toc}{part}{#1}% - \fi - {\parindent \z@ %\center - \interlinepenalty \@M - \normalfont - \ifnum \c@secnumdepth >\m@ne - \rm\Large \partname~\thepart - \par\nobreak - \fi - \MakeUppercase{\rm\Huge #2}% - \markboth{}{}\par}% - \nobreak - \vskip 8ex - \@afterheading} -\def\@spart#1{% - {\parindent \z@ %\center - \interlinepenalty \@M - \normalfont - \huge \bfseries #1\par}% - \nobreak - \vskip 3ex - \@afterheading} - -% use inconsolata font -\usepackage{inconsolata} - -% fix single quotes, for inconsolata. (does not work) -%%\usepackage{textcomp} -%%\begingroup -%% \catcode`'=\active -%% \g@addto@macro\@noligs{\let'\textsinglequote} -%% \endgroup -%%\endinput diff --git a/docs/latexindex.rst b/docs/latexindex.rst deleted file mode 100644 index 300e60d1..00000000 --- a/docs/latexindex.rst +++ /dev/null @@ -1,6 +0,0 @@ -:orphan: - -Jinja2 Documentation -==================== - -.. include:: contents.rst.inc diff --git a/docs/logo.pdf b/docs/logo.pdf deleted file mode 100644 index 3e8a9cf480ccbe4a30911bdb7d78c0b80e767c81..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5677 zcma)gc{r49`+t;e$QETcgp_T@%wS~6zVG`|8OtzXhB1>Z`&LMn)Py`p2-(S2*~h*l z43T6jvZY94m_#X}Y;!T-^XFDgZwm)(zne z2*?Vt?<-rZW1HTVs9|P(ut6NpJVr&`F-dF3rSH@}3{w&~zISM8m6kfF9OZP{uY^S_ zWgyg2{%hx6$lWQ=skcAB9Tu)N2_Ei@+Ax29yj%bL=hmHLO`PskrW{ciz&8f!+^Px%t%U!$#9d7!T9+=i?az9@J2Fixj- zyx1kdT?hBX=<#<536b%Ij5Nwf!xTjyl6rg7XKgNrHz42kusDXz1CmSGrIXm!j3_Z) z73X`EEQUdjslimD9&Pe!Pn+)Cj&$5wdC?%>^Yj*cH8Y2(oc@_q7@T&)+I=vXCt@Z0 zc)>fcj()K5Ug!cOR0+{nzw8*?5NFt+yf z5#sl9qSQ}*A{>R8;4l!xr0%n^G_APwdCTYlHeCvbI9{HaMO682sCbn*`8}xr6uR)# zDN=G9fG`R5f_igNUFev$cl2d9lny&XXiHpg6SO-AFyU8IvP!RJ{sF^zK=&c!V3%p%5Mc+ z&!35_-)!(H4fep7l`K_}H@;Rvc)8PjBfYnbkWi+-d|VRNYgMW1PY|($ON5*rcG2sz z%Pk(>zrMf1;mGKtRK_#ql0r50ku^~n-yo*Vk;V5&w|fejD5;YmG|Dp#jdMv*(M!$A zyoV4p@L6N~UXxa*tZhh;olo^ns4Qe%O;hh!Pg;+FT zB3GX)tcNI_k)_$4y2_Gx{2;qpDNBcmWdp=8NOfiiYTTckGV)>0XXKb*e2g^Y#^aRM zI7NP?b)lMu6%yl2xzMBfV1BUCAk~>+ZRk7uC0cj?|5@k{9RPvSY^k0-{K0vEB~Os&jKsc!u+F4 zLH-WSbaoQeP1f$%(J|k3D8u)lmA}^BlU~e*9#g%RaC&d9y@h4>YK~ceD~@GG?PY@N zfNIBIjUPs3)*ZYU9P|{l#No7+qOr$Fg68Ih!c-wqqGw_PFHQN-R|yq)Uy@?>v?;hI-Gv zi+Xj+sZ;Ha(A!~xi4+~7q(1hw`(PAZeW2vT=r=I0tsugjSzSLe%p{{~b*$DzR1wHSUj!a65t>AX7f ztU>^^4xomK$v2@hwi+$=O^tvDwdNcPbfgYY97qKvXL5G(4bUF<9sQ8Bmd2UNhCs&3 zE9l6Zk7Yf76JDfUhPj3h7m17z$`QS=Oypp-a&c^IyFCy7A>C>G3 zg^qgT%Jr#8ciZ~G7mH}R-;aTP(3iOFl3B#BLw%-M&@Q(RMB-}!szeul#ytP`le z4Qe~w4XqExuChH=Nl6zs4pif^d-hR=>e-V*hY{bjD4)<*T+(e`^2}!q+e<|QQzpA} z9BX(52BRIBukc;sE2lEc?j?rY!xAo0Vb)%8fxWvA&E@X58-Vyu24qQLnwCo|c zUpVeWfK>^;RpYUsMTNt0>;xR4GFCL1Y9_6(L=+WQqgG!+G}jb==+~CVZ1)pXUlV@_ zz0*r=fjpodG`}7(X(j5)d>6PZU9H{!e3CtTqtaEU-CCl!q= zAM11S3MQWFYoTXr47l(mRDDWtK;wKiyP16X4RPCz`Gz^e1cT)C3NP4|>558pAnfYA zIPQwYx&8)jy{?r`RH;VmqA8Kl!hJw|ki$}f!9Hzb%X?r+U0jFN+SQkXX*{S$mPIHl z#bD=SEa(Hz@&X6Y8z!snYB9vbY$3YmRIF3wov%N&N0Q2Q$1F(SG!>p3&7n>^>xVV1 z_v@f>O{}S2<#Tw|+#S^0I`E!*{Mu8VD3XV?H*;Z&+dMpouP;y>DwEhs~jQm z%Be4v+PcD1J(gQgy(*db{>oL)&-DHO}#?>0w23HB0xkzKYX|speK!YbO-9I5A(Kzr{Pv zPUs41Edu)Lwg9{V3K2Gz>qpd}CsHTWKelj6rn_l~EDLTpsEkCiRAYN_<#rZZ($@ zHLR%B#wQ^%6?cWp68^gMEeC2V(rXLnn=C4Rtz;7g)j8~&U?Urz zS+SNnDOd3@NVLYb^x)3>!O6xu2B*Snq8a75Up+k^y#=_fV>-tinTriP@$vRWC-tJd zsGQL+plE;Xn30;-=`$p|-b3TCB-rU0*OMRWiY1NnuL)=m_6+C+je%01BftJI{f2i9 zHX~Z9RobArtiCt<5lxdG*gAN6KW6smT3M6u*JKY|!uIjkwB=ZzD=Cgi)D~cbysMZr zSisY}rbipLcLEqPGinWm;4G0fSGCbqtBf{UP4faE&7I{wC!<8Q@^yr}wLU9x&Mb^% zozQzRV@o#PIi!)XO<`=Cp*?8E;$4xhl&U@BDPp%ka6@9b$eW(wTNOEyS`VXWCiR>| z;L;2R2BgA_vu0m)ZfjViy*2SLFpHZ#kwojxKiS}e#;uQDSeJR@A4dLTrTSxgzx>S> zet-R0Rfuxv^KyxbGXk^wg5uAXb1<)`Hg&3YoU~pOcjB!|yuml^PH$h-B(*{xJauQS zrl)qu%-SM_Yb6clNDO=A$F6*upln>OEho@0kM3$#9PQ&S-bRlZzg3ZJFZ`20L8R}oev!`A zq6gL}YS;UUpG`UA?D%rZ*bLNvFvnjr$5p8Ry!BC_Gj;h%HuQjlpf)rUDI6i-p?ha~ zs3Ivdi!R`SWP?&MKW!@`WN_pjUJEq+=1$VX~RYC++L zQ|FK>G#|x0ec3y5knApTpqZCU_!^iH;}7|1QrM^uEHu15h-%ew=Sl5ime#(VSf6@C z$!BJV%jfKL-w&C&M)Q~pX2KqEv^iVtc;5c1$s-o*0$`I{?VDlUs3GlDb{0tcH}&H` zN2jLuK1S1eJISo-7c9#@Iqc!;nsP$gAzsO^cMVQ_FxiTiIx}b_5}Q);K|3+}+~jrc z#z}+Zwq4JGUW<7J=|-XjOSiPI&F%bFL!Ra@Pp;M8 zEp--*%%c)5c`)A9Y*jd;UM~K&Q6Og&wNrd>)ysLJDr1Gc;xs1Y$G|1dC8uF?)olX;bk6l8tkVRsqI_%YAd zOEjT1T8IP^1 zMXRY+E40)0iTHKaA+IZoLYaGwD4LLW zsATuidl@Qc5E2Zz?`ZgH1TW{-Ek5wd7h@l|+aKEWmXRGTRN+3er89rBt=RUy|MjM< z5u-x2{i$M;s84zmO-@0s$Q`Bq9j%au+ZJ=z(W+?)MTcI`@Pc2UKklZ&Z&Wfe*S$4= zK*(@ys)~@gA2sEe52jt6blw z=V%PO)>vbf&tDr-Wt}CaTC+jS5UvNe2-Dc6_UMJ>gU_EtW{9S9vF2U|l}?q}JK#gm zT8_BOPCKo%#aZ1dChyfBDZQ47eY#pI>>O4m40(D-^~$cqwyrjH9PUS}p#nFWF%1Xa z9&@I$64d7G(o1;em9Uu>QKu3V^zaVmW=6|OF-7vF93wg;6@6P~RS zW`i_6sjEM5SL-$}FEes$hFo>{MiN8zW;}UtrZK#B`63L`=^!@xBP%!yWaNF* z?6O}^_)I|DtCy(n8xGJ<3~UcLkAeg%L+%s8?+2iG23Eh!2F>k;O@;a#?5f_fb$knO zL%aT#GstfgA%voSP@ZJ{11bxLPz)$T+5hMyN6Ls+08YmOM^;6EN=g)fe90g{z3QB)Sn9QpS=RBV!E=8b`MF15(7DUrLS+7K8Ws zTdu#{AEAHJw;%__BG7(5lu#~#e_#zVuIY9i<>F?pqfP;TZ^zut4}-_LxcLDo)R_Nm z8}j7wA4y3Yk9NVKFzBOrvPaozV!RP3^ikg6KM8{I$H@M1 zSiIY>+n;s+=s-$;{hKa#H@_pY3{bx^q`3Z5Hw>QAlz-!!LfRh(8f29ahrt5HT@WZN z1_+i`kOqT*;vP7hkD?6ufRI6VEW*bF<>Due!MdM6|Enfgj4R%StUCVxFZ=Hag8wc2 zuX1Z3a0oBVQH_pHli%+%^xriBST`g91O$Tsp#NMzIT#EA10sRHF&G$1c1^i}=sy?~ z3L?||PYgsZ*uOC-M1kC`|FnZDK*@Fe7Y6%Ze^7bQ|JcD~Dc%3iwJ`G0`7egUB2Zp# z*dtBX0u|&&*&C(H%rO`okV4U~Z-O2gi2+gyc650Ca0o2!hzl5m{Mi!~)iTir{2%%h Bpu7M8 diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..7893348a --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..cfe1fd75 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,4 @@ +Sphinx~=2.1.2 +Pallets-Sphinx-Themes~=1.2.0 +sphinxcontrib-log-cabinet~=1.0.1 +sphinx-issues~=1.2.0 diff --git a/docs/templates.rst b/docs/templates.rst index 236590f2..dd05add7 100644 --- a/docs/templates.rst +++ b/docs/templates.rst @@ -197,14 +197,14 @@ without the `trim_blocks` and `lstrip_blocks` options, this template:: gets rendered with blank lines inside the div::
- + yay - +
But with both `trim_blocks` and `lstrip_blocks` enabled, the template block lines are removed and other whitespace is preserved:: - +
yay
@@ -522,12 +522,12 @@ Working with Automatic Escaping ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ When automatic escaping is enabled, everything is escaped by default except -for values explicitly marked as safe. Variables and expressions +for values explicitly marked as safe. Variables and expressions can be marked as safe either in: a. the context dictionary by the application with `MarkupSafe.Markup`, or b. the template, with the `|safe` filter - + The main problem with this approach is that Python itself doesn't have the concept of tainted values; so whether a value is safe or unsafe can get lost. @@ -1249,7 +1249,7 @@ something else>``. The `else` part is optional. If not provided, the else block implicitly evaluates into an undefined object:: - {{ '[%s]' % page.title if page.title }} + {{ "[{}]".format(page.title) if page.title }} .. _builtin-filters: @@ -1257,7 +1257,7 @@ evaluates into an undefined object:: List of Builtin Filters ----------------------- -.. jinjafilters:: +.. jinja:filters:: jinja2.defaults.DEFAULT_FILTERS .. _builtin-tests: @@ -1265,7 +1265,8 @@ List of Builtin Filters List of Builtin Tests --------------------- -.. jinjatests:: +.. jinja:tests:: jinja2.defaults.DEFAULT_TESTS + .. _builtin-globals: diff --git a/jinja2/lexer.py b/jinja2/lexer.py index 30e82fb0..c4817f47 100644 --- a/jinja2/lexer.py +++ b/jinja2/lexer.py @@ -352,7 +352,10 @@ class TokenStream(object): return self.next_if(expr) is not None def __next__(self): - """Go one token ahead and return the old one""" + """Go one token ahead and return the old one. + + Use Python's :func:`next` rather than calling this directly. + """ rv = self.current if self._pushed: self.current = self._pushed.popleft() diff --git a/scripts/make-release.py b/scripts/make-release.py index 6ea71629..f980be93 100644 --- a/scripts/make-release.py +++ b/scripts/make-release.py @@ -25,7 +25,7 @@ _date_strip_re = re.compile(r'(?<=\d)(st|nd|rd|th)') def parse_changelog(): - with open('CHANGES') as f: + with open('CHANGES.rst') as f: lineiter = iter(f) for line in lineiter: match = re.search('^Version\s+(.*)', line.strip())