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 | 196 ++------- docs/contents.rst.inc | 23 - docs/extensions.rst | 8 +- docs/index.rst | 32 +- 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, 142 insertions(+), 1149 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)" - -clean: - -rm -rf $(BUILDDIR)/* - -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." + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -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." +.PHONY: help Makefile -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 zc-pmk^;cX^@Z~VLI|R4jg9LYX_Y4FXf8$LRrp zH;<|cvIaipM|qe&hW*RW9WAc+bG0WeqTt`5nd*N_?+Ff?WBp?mc+zeL(;GS4_sePBJroHs6|Z8g&H*l~@HM7$G6 zSM}K;s+(El7E5A54mSBK>A*}E|LbGV7emDWHNitK3t)k#e7Yy|14X3Y?TAk4AyUyk z9S>Y@%4VkC%+YiVGj(w{7)LPeq*liI+8CiIExNGk?HlDDsU247-^&i zzaz5I+OJBMBZLKG@PXipnu(oUuZBn|_SJgS;GydorDO&jTqKHN`YQ4vB+{>&c^VI; zA23Io-P~dgBuf$;ffeRY=li@Z>m1eBla)c8See>#DdV4&)L;+ z>Z|HAQkgd0qNslW*m=o9KNbY{drJm>)IlMpt}+%arJ|Tvzyt{Dz%R3BvB#Z z>Fe(7v7L0>Jg`f>EqsW^WO%sedQ~^%LWy2`%_wPUkoa&JqRHRmu@TEE2FT&}J+n?e zZFSL5S4S~r4>LkPOGkJWCWN0!UHo5rI7H^e#7bdOvs~}Lt^untoBd7gNUqvlM6S3$ zlsRp0ip@_?eoCgd52e{+U4zrj$?E+5m;#(sWzC!6ibv%^<)$$wGWBc9z-fZkk~y>_ z9#DVZO^=#|Q&b$ke+Rj&1;Ots)>4AMc&I6-mnvFB)8vfRP@5%#VXxSA{sJa@isbEv z)7h7s!GN^2RKhGw6D(6A6Usr~Ai6{Lubs4Hnb$(PJ)-7eR^7A%D;X9>*VykYRTleG zb~Hs62#zg9$clnD>oEV-5iT@OmOQ3l*9gphKA=9PcADu_4dG~6w%`YoRrN2p@rQ7$*)G^>x^y+)G`B1Ht}lT`!S@6S|VejZ&U zhW3Y&?ZTG1Pi#15-XUI?kx|BLZ~o_Vx0#vQulno==aI&7F?Fb`QSV1OiDQx7)4IT4 ze?m@%fJ;>k-m6FMn%ONKXm-I`b>0nXWMG~e(>;>yEs<*+nth3&!}>A0D12|)wnIL< zH(mS;C-0)9;%Jk+<^Q0wKn(lYUD3%5vC zZH@#h=vfzYv31C03zZ8LOP*mjbTj$7>GX>_kEf7na3`y_#O9MBz%_a9lL-W~zJtHk zLnk|B0~XZ>*F(giRw)!$D$si_IFvD4^I0&isR2w3?RPot#jm>@f%G{7zk+zO0!&&HyX(mgc+#X89I$(#V z1Xrz_`yPfm)h)NY7Vijm{&-aEjPip_GiQeTd=i?-v2?Fy>`j@}!k`)T61~a>#2I-p zmk3ARH|%N>xV7*EN|nzG#LM@l%LW9qmC--ZwVJ+a+4UU5UPRwqYRJ3UBAymLHICEP zG7khIy7=m%(`^0UL32jdsDm>tK2Wxc&?Fb#v*baMbI<1}_$Brfs2E4><1 zY+^b8+Uti^t&l;7btJsZ)R{=#n0Ctsdly`9H=bW+v%IWHwwk_|mVs)7(>6)Q8o=`6 zt0E3*9aZ|gpu0UKE0fIrvt>31o_)jcJ2zVia-sXM_}!E%&cA1+eL(v~0~_kaO*da2 zwA3|$XM0D-GY!5-CecVy(defTdo{83z?e_RU1w_euQiMky6@$q`0T0N0xYEy;Y71b zI)CN6uPTHXH7iEZ=>us!m%`ec2irGI(LYpvtD0yG@?pKg^OvO}609CjYMUyg5M?o{_>D8lh2R@6-N@{eLp<==GF*1Dus3)8_0&Df0-A??Cs;2b~+OvDF0 z&s0vmcX$SOrZ~rE2fc!ST%s|a8Axqd8j&f+J&jL>1m@g7ICy60o;fD2JVO1V!^DKL z7txK2me);6t}YWmKT_s0I)+!c*pdvr3t#knPwx0Q@n!5`$+QeMLT0R`H%(a?fHvTd z4gO#ekHChZmEZj#y;!Jm-wfK<3738mt5DM8Cud zP{Dzj`Xo8HW<*^WK#M~zrwi&eFZ`W46S6*S^X6?D1!~;rpt@9|% z3@@P^;oL9jfGuOM_;t3lFAjj5vS4juMlCLvV?Dq&fMJ+ah1OPiW0#C*C?_Y zK4{;@5rHr>EuC*J(Z$I(j0Fh38hfrAoi;Oulz@*TW{gldz4|a1X|o(kJ|*oj7sBGn znYTT=Se{T}W}GR_;e?+liS;MsTE5{fFPK>^za2`ZmGo0F-}OfuA3IpO+EEHv!Mx}E zKvgYN=g|^NbLRJ`7&6KFcjE7z;Sf)g`13AVDKdOt19?~-P>pX9Xb9{Dav~kAbl&$w zMMVi)2QIt#D3qSO=nFj%Dku;tNd|!-F-q@>Q1rmYM0a8J9^;b2jtMjGd+_HMl4EMM zJXvQ&K1E~#>2Pi4`b17Di9CPvyKVe1dh7{nP*|KKmxFnV1`QRYTi9M>cNS>FKP8z_ z>t{iGVhFXi`tX_Q|4Xv#N6^eQv+-L>3s^i|TsEJ!wsmNRT-$OxngTC63EY$ydQ#Q$ z@AmnUeEiyKApq;^|w!g4@D=L7Pi9eesU$Ka7PWqM#R+Jf(d5K*U;IS->(uu z3Zk*VgW`vA8Kk+fJaOr8vCh~lKba%$P_10))S9>bU)e()zl%`?GdI8R)9o8Fb0KG zkQEzAPF`N%O0Le|f!ppN}H&AQjU zA{9=c_N@+DRO5J7`pR^NlD`^;{A{7Udd|_&eLm?PoEE}aZtoWGQ#H9XK(_A?yPQvlOJh! z=Wwa!x&-+7fe3-(+UqSloBoF{v;9|Jf})`XIhiQHS$&wC{AtdJ&1aliYUARSq~}@Qa~B$M&#*{W9<8 z*X6dOpFXDa1G6HG7|rDM(^0{qF}$q9{?qeu3XH3ADBIc9Dt)Kn{#S<-6=l)Hh9em9 z;#{Me1mKwm2wX8!mI)(kotAQVkI0h2vHT1F@IzHJzBCGyj4^Pz(P>_3-J5gNb@{yn z(+?MQ?K(i~6|dan0fBmM7ee%H>6wlZXV7b@Sg|eu?@_vQNzd))SL{O%l7c`#ng=LD zki=@>ox`}NzoY&1;+Z*)iYnw*li)JG_5!o89%2KW74AAs{KV3;jn38SKPXloRLyfR z)(khZUqxza#9Wr{x(MUnt2z_Qx`k5ZH&<6zYmfL(XZ4aFdce6fQy$I)1q688{mge5 z;9E^-O5h=YlbewdMeuEj{F^XvU=M1kdpp2MmaQrKUGv~Ww|q9B*T2Oq;PgwzO|7$l zOtJXYn%lq;Ym*D*8%E{2=mG+>$28pnP&7h@+(nx4qvE%3-+n%>oFcnnAULFm5PHoF zOnt_%Ud*wMaf!{gAngx2NFz<=69TdZ$+a5)=|OZ(8Wo8;L~+q;Qc?$m1Nw&>KOQgf z+oE{+>XwMiMZxVbm)^h5zvJP!B3)QQ=vRH;$0~3G8plbJmeRnC)xiXyI018H8!*Rh2;uT5$~yJ6{vof*aT*^9?AF@JIl`O zfkKwUJWSsZIGqX}1uZ?3{(B>8{+pO89g%u~N*r6OVWnJ&9rb{&YeYP}Ebg|U&^26z zg!qHL_AfBp6i?x1W)qD0fpg3?N-{Kf75!b5hcE#z9J|fOSEH=8{5GBlEI^xfL>1Fp z7a*2^oh!aYKAu?n#C@)Vl9^yyBo2CwR9%vtec&n#h)!x=UvSdgh9QyVUc|lQqXnCq#&)*$~J@9PT$Y?evGrI3q2< zsh`dehHpi+f8`x~zZ_&5OR_8Q+-Lk~zfze>WH-QBCo&Ftx3eVZl&LS`nC`*aRaF|f zKb)CNvHAV!W;5RpHjhRMPkkfmwN2{^Fc1Mh^8`rYcla+6COP_;{Sn-HlkGx}1z*76 zbP!xX@j1k!B za|nJ8rxV#;Y_4#BujK?L!FWJhZkxl6(!92hnOGpOc~sj;1Ach2Gq$x2A05B2Zo;ihpoCiv!k9zI(qOE*-&g(3W}W5#H)0%WLvJP08t zn$N1*w0qoIjHa785c-0!I+-?wzb7ItqPMA=c*&!jBo#ND>VTP_eC zhY7+u>L6LJB2zMG_@ES`*aKN&wQTHLZ+t~M^bnu}r}4X^~LR=^Vj)iKbzc5XCPC*AJcYQB6Y)qERRi!{H0Pm>4Zn0t|zZhXD6h zoMka%9z-RYkZNWc$D*7&tgM@K!DR zvYwTxE<2X#3v+X~(GKlb&Bc~y!2e)`5vsw#!@@juDk_WN6{SAo69XRwMly7u=5? z74*3G63O>)By2o?X6lGEQpvGHyrzMpV`$X3+@@EkMp{W_8q!t2yOxas${+E}a3Ie9 zPrllI4!Jk2697;*X7w-;>Rc}5Uqq2kxk6^$j_%Nf-jY-lB?62*^;u}EI#6~dKxp?aeZ0JmN!Un z+o1qG=npg{$~$stV~CqfD*<6P>~BAmb~*?=<;X;6hxCNUC(Xr-7#@9a9qUN7>A+iI zm{$LV8JWa6IOdXiOOZ{co$cN#B`7GkL?g&db>6QJiww1NA-^79rHKVYJl`r4flWnz z1y<|O3KMQcjFp|8oz+Hr{(01OfCH*(YmZ-v9K5?xbWPE!9;Lb2Ztrm&erVr`l1n_( zZCjOiL5RND5y`8N{&ID^^v~5@r9asz`G2NK8xoSuFP$n9H3U#XW@LA>d|{n%w@r4% zsAyn}(^*oevaQJ}SG1z9Mw#gi<=Fg?@cWm6SsnPD?Gr<>21yhjBR zzGq{NV`5cX8}U3Y^5k{4!|CjFt&LNh(7ahV#r|@r6vDCKzf0jWu}4E{ndo9EV+#w{ z0MB%nTI6p)sPxBeHilkDH4-rN2Or))bY3)uXw8yiu}gAy({^&M}Q?h91BVvoE+G2 zD9ghw9?I`Q-r)p@S=~4f1ar#hV1XZ!=m*u;{S+b_?UL zcPbY6PVdb-^Ofa7W@rD?Myz3{qerx3DKpPF-Z-L4CE{@rO8SBS-+AG-&W>BXli z{AYSSYGQd3PjRWwWT-&8S{k8Ie&3dkpDMz7x^6I}_%PzJ5XJdbc5wEJcsVjk^Qey2 zr~@wB!3gw06wYT_Mh5tUnF2kzlxHgt52pR$X))mGI?>?*l1I-7BbDuUA^x;^&+ECPPcu=YpxXPUzixzoW`Qhud4O*{KoCXbE5r!z<;L+nhNzCFd z{W6@>H5OFf=)Uf3X|r67+Dvl#Xv1zra`Pgm-E?8g!|Q$Cq;@ueF)kZgTF`B!;H7Ex zM9ZP_bhD*mT5!mZdg$mjN){f7<`rKucYZQ5=t+7YTcU&iFJfwBrr!f4gRi>@@Y@to zYBmOAg-_7dI$UTVO)Qr8aZEOs$^Aup3hTaN8Mx-(s@QJLV8_qHviLi1cnb|7qwxI~ zUw{J-7=Ys}f;zT+LT&ywD3-nbiUBUSNDOF|v9caGZ?$8EWB;C*So_nHcKv1*01E4* z7tXr;je1WV#Mb;TFPu;M=(NovFN3upKxM^=^5lA1KDyccGwnJBQ zuV`#1Ro`el&z9?2#5JSq);xUFAr4A*gs@MFUXs6gyW@yN--}F^SC)C=+tDevkpddWkoq}#wHROb<-sA9t~Auh#qn^)Tbqv zzUn6&T41+HIa^wuPKKJf&dzr3!JCiJo9_t>jPY2zcnIibnx~d>1hBO9u;ZXn>2{L? z%3aUQ9cQmdy&boW1k8@fpIidK??W#?YL(4)M8=BM05g|rWJ`-l;3Q2;rzPYzVrHZA zI%YoWk-F!cRBMYr&#YnnRw0A~)wG$u>3&pTQvqyNzswPdujg#V9_!@G=V1nvq5bYD z!Gs;rXWzwZd*{c{|CLDpMVhNu#cSW)3dr78u>%3&Uh%>wt=m2!kq_VafN@GV{{u_z z0(eE9A=1CVQhNi6qA4M1$f?vGqDW^|S=W}tB!QQ_&w_Sn_-w1&={Fp2tgs+2FEA=! zn(&d0^I)2qDgFAO96fW9*%WQF)8eB zCAMUCbeFz%%R|0>_cQiZLqolg&3@hFNJQFfF7~}iASB;*fx{TL;lNB*vR&^pW|4%} z^uHOi|E!B*KA0h{$9@&7P}@)5$ud_bDI3o7TEu`@VS(mMLKB^=@S;Fv+$>FU?x=B~HAC!4R>)E_@!Z^jb4Ff<%y5{=G?WB`rga8=6ezXLEl+VxU#dy3gY7`PmwQ4vxN!k4@Aa!Gq%d< zU~k7NkkzHQ4#)D39q~Q4mZROTz8wBF0Ft6k-oU2t@g&GxrM)pZ|BxnJGRA?m(f^q1 z=e1YG#l_X%q&g$ZT>T6)l$S@|eQgN!*4+H*-t{l9dOji z3&gndgle3NEjxB@TTjGS{0=OZd|p;j2tve-^>Oe>`-Lj9Lx$L@#P8cjSfiT2JVk}s zYX~c`!q?>&d)TFe9Awq6;TL~7ULcUQj(yXxI&hrF4xGYW7CRn#;?9%V)+Pay)YcEp z2)_Pg9g!gb?_EE49UDG7w1qQrj`&_qDr>%!7sCxCHT=+i^3RN}Qd6@le9k7(0sP67 zUyZg;2Y^slg*)=r@lPDAt9C3>p>KKpnt0%BfFIM_rG%i|l(@UjnC?AhJ`0KMva(>? ze59fe+PsB=CM-&i2bls3$Fd{~%VIhc47rG2VO2Fsy_jFW~Op{Qj(Nmj3?2upfm z_t#0ZGcqzf|9s=4fFQ+K^qfBO)j05GXOh6>zHnyQ+4>2!ZmKhiL|L&7AXftwz_f+b zi;ZtUORK?vnMv*|jt8^tDDO!JOm6tZ?9N>`$5xwpW*>P4a5x_qklk&6`1=#0x3eM> zpV&SD-pWfoZ}WrtyeCyPs0uqyDGBD~yy$gN!#u;>5$RaOT1~Mm#9dtRvz`M?12EDI znXK2;CDY8XI+3MN0z$d}4| z4|7I8`c_!K9Mf{&BTk@VN}i<{@ju^C$+y`;BKx|5xe|yCY^HoL9AS`z3C{O^zJ!?| zpYTk5kGX%R1##0f&pI=M%+AahFfFHP@Qf6SjN@Dv8#eRgNNYu)mVX~Z^2+u$RElam zZ9g!XY@UCtJz&*x08?Wu)$xiG#-A-q;6h5QD4BR%(ssLU6wbFLh8w<;l<}k=vl(A#N+HGcJ#oq{+m5Cu ztfVRM{z`ij`x%gHn=BPHJ23&rA5e#s4N0gC0pocdBEkjuaV;ZZ-`vl>@aacH+V|Th zFTv6pSN^?6>FRadyqsq>(0aq@CCWxiGovKwW1hL*%+CU6yM9{fe)yWUph-x^+QQf? zs=YJa&*~0Hw)656=pHZZAd-3eT})Dv@%${-p0FJzyu0-vw{xl=WHk3iosVzloa@gB zAAchDmn_C!zs(`mch)P#S}?uNcdy1B)*pxod=0bPqk?>WO-~r79;P@>zsLQ&C?8E9 z!#9dxYj1P5FL2W=1d>^147z_kW+RF&Ki6e*<7bkP&UfW`;GXc&2= zEJ;sdoCn=THa3axC^1ZRb2B_oiew=7-yv{kRGI$y$f1VxWg-lb&vSLs-=nU|Gw?tr z5@m`%E`tG!+=9WX(f^g6tnkwyhYTNcMXUNEKEq~*(YT-WB2D8rP6OYujFhp!BwaVt zkVQac{FZ21J2EIKeEq@Jlxft4HaD8N`@&SJ_p!jbEvWhUY$OjIr|!1MYT44~ym5#u z=|u#HT|79}6lhd|C?KSfazD!=JmkN$B8KtNy5nH^^8u4L>F|L0TB2-a@*onS8clV6 zxpm6Vom^#?R)*u|@o;mP zo)*8(MBHxEl03HVh|9FTeD`-T1CrMN2_o&sTiK+6i*hw7!q+hqUH8^fYUr6J%Iwn@ zkuSEG3ESG(kiDY*xVBa`Zu4Tq{`d2uy6>sm1Oy|e*O_~oMiJa4rnwsYo|+lV$RGfu z;85;O*e0b)w$Z+D&)O-#Ke3uBQM@EG=$~xGXfgKk&}8n=a|eUGgtlIqpi-=`oozGy z!oqOm!I{MMgbBZgttke+--}l0_b>q*c#3#e1vsjlk5tJk%8u~VqyjVJh9Bq$tgsA- zUO?9oV81%TN7w%ng>X#p%gL1@K3sNu(HbM?-9O=!?Ylok#M%N~A3rUYLGMYkSF8i5 zU32hlDIeZu;=ln3^6oW^np{CiC8A79)^1s-*;z&rDkNqHpAbbNZ*k`39HiFOW2i{^jcr7=0pCEIN)$Z)F+w=k#Sz%u*pdiQJ|`-u&68;MdruPO*U>u%2^NT^aw#V}pxug+fxdr^rx%Zk8VUyr14d zd=BtxAX_SB9|n>>naMG8_w@)0pY_vKO-+xS^abu%8>2b`^L6P9Y~3GDn%Db^Q{?WN zQG3?93Af#lfBvQN6{$hGJ}mrze{{t^oeub0ozkFkZP6_ystN%8 zn(EK*q{o}0!28EdQ3kP-y1KkKq2ILydfSVtK@1S~FW+$xwnBglZw1w*T@EZ-mr@Mg zNC5QA2FuMcwCsR-*==SSp}n)mWemBE(Gs&A{lqHu?-_H2VGzrdU)nfUdcf_`_? zi%H7XLB2ne>7L2WSMiNb_e;nE@yQ?zVeRM5O-;KRS~1+iL0XyVzNxeHz&Td}&o0&z zQVW?5pI#K~>L<4UE=c(jxpSX4BQS~EWz<7QcX)+|uUE+ztBB z+&JEh*iSA>+hKf|Ee2&Pk&gv`=3m}s+yfKy_?jXyuMjIT=f5S)-apPhTl)mQih}lvJQ^5u2-d!*O*|_jqB*A?yZcgy@WBC`cpth^GID$J=WpN7 zWG{gUo}YQ2I#HjGb>MpXVvt`VL6zUNTr0&9?d-2|5oNmWM9fEDHj`bqkAe01YRttw z0MNDb=&w?)_eP1-d*3e*$YkJ0Rp_XELOBLIDu}|NEh)%HuVP7j1ceI~Q?#o@BXq=- zm)aq$bxtXNx|ol~9qoWOR1KYdp`Ltu4zWKO#WG8V${A>)Y$0FuVE}Ja-B1&;!ABjk zk2aRnHEzd6IbZc_Y^+Ob=cpD98GhE-SSKg2PthI6Z9yqGT(R7_2&|HhO{xgzplu>) zh5gssC_oH{<^_VZdwIm;%#t#By>)`w)2X?3zI$wEIRiH}RK`dTiF zmBB_b`*^qlpA&_>c6PTCvT1Pg`GrZ^D|lZ8P{76Dj7-If$1#N;oJ|(+6o^isoTR=r z$Bu=_oMNKrPZKoC!Ilh`oz>=y;f@?{I1O|Xfs0nKGEZHowQ;vMH}`LQ$6u5mgiN_b5U4a`_}yX@zUy{^L7b3_?a@V~G0PSfEEzmePh!?}L(8>m#E)0+lnIvH7fKj%!HyoGaS(@qPN?B4j9k4C z48x>LLL*Lso|VAc?J;v_{Gk8(V8zN%$dZnb0-}bS)P^e_i@2ntcim_}^;46t(@C}- zH00Eh%QfbE>s|Yos&@VQsXEOB%E`B_|H291Oo}Hcj z#b*|G==-NOh+V842}}yzQ01#hMTtboDwsad(KS=fR*Kz)wK4-miOUVH$J6l#XywJP z_q0_t_x$va)gE^gS#u|v-4_Jx-t0FLT$+eDrkl2{hO#-j>hgk(Nie?Sbl{rhd7Pi0 zNpX%y5WVcJ$OS7}yZ^DK!}agP++|;ss5&42^{+n3rKX@jg=S`5$nA1`sI|R(_J_CK z>6qXUZHlDvRELaD%3fbcnr1$wjLNH)-;@-;UfOukC(K`eh!`s8Lv5*@kgCN{s`IKz zei`o9V$@t)1b(}C{Pj8S?0Ut6Vs(-)oTNdz4X^h0)yY` zLHd5g-*8@QI@A44b%g(2PV9li`Cn^Qc#UfhJj8HMHCp?OqrI`DwlyM=}fD z2YYvN|GO_32?s=(>lLq|&hRJ{m|~K%r%KfUWlPrmoZ$B!sP1)?{=W?&Q850P)R{2DG+54A zI5XF$zwu{|Td}C@v7Dbi+fb6XqP&L%A9ba^*ip%fXxLXo!YCL$KYss@RtjG$PwbMI zFVIyLsD_@3lB{-u&VdV#wx$htt9HuCujR20o$Yw>-5TTIztcCq-&?E!s-}?sH(CTo z=VigMSV;|$b#7Tvo36u6fec=HVtIBidiNqUW2N1IhSE wxw}0About 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", ] - -# Additional stuff for LaTeX -latex_elements = { - 'fontpkg': r'\usepackage{mathpazo}', - 'papersize': 'a4paper', - 'pointsize': '12pt', - 'preamble': r''' -\usepackage{jinjastyle} - -% i hate you latex -\DeclareUnicodeCharacter{14D}{o} -''' +intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)} +issues_github_path = "pallets/jinja" + +# HTML ----------------------------------------------------------------- + +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 - -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: +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + 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 Hc-jL100001 literal 5677 zc-oa%c{r49)Q_?a*`n-*kh0B~8H_C1_kG{WV1@}ZjG1iNw?eYKYC>KlgzRLi>|;fP_5D@Eh z6`-I1l+s6HT=8x|=mBI300MzhnrII^5_j36@WJDd2v2}tMv!e! z$$SmV&0ol7pA#5Jcyh;S=8-6?0% z53o-Tq!4y%kyUxzaQjxc{l?O>I@zwrH{r|aStP~OkL3Kol-hj1q z0}XeA=ODofh@RR-`@p&w{Vqk)^#z0Vts6bg+kR6d#kLbnQB5sg@=U2gr)xXzUo99zQmDmxZZe$+^c!h220qr}nYUhRkAxyO#-;+p`3 zQLqQ>LyfP(wB{?_X|sqhe{wpFI7bvZoU|$IK_$jp@#K8%?WtGk(u$Zq3Z0>&Pmr^i=%)9+gDR7~x9 zomX+78=<6Vq2eI%l_KKvt;XxA-6h1h65Yk);;?Rua&2FtkU3l|==7koPLEA?;o$DI z-6b}AdM||%t_kNPii!8k@rr~x5lyxXo(I~U6VP~ZtvG>Uu1RQ&bDWY+a#s2s1izlw z3d`53lo~}%eWLVivS%{KK(PTIEBUk<&m~$h9T24RSO*WC-FuD|C7o}|3QF`I{_%EV zEmO&L!n96g?zab>7R?e6Z1_8DBs9@HK)x&@kL7qGqiF;VzUA}I#3+g5w#mxvy@d%ZnoIH@MaZyj>7x2YyG z6DV#lcSaA7c&|d~z6LD)z4Dg)Y&!Uu^3}N0J2S0KOxstoO#EE%Oj9b)<6Qcb+y1V9 zH!QVk=Rs$uBc~w>r!E(cK1Sv@HO&{K2#OFs6Xkzt!i%;-puqEz1f#oEaW)qxiBocx z3IT+Ff?uZmqS_VC>CM?##BhNhoUQjm|6yRp9MO$23LMh3S9D_5O(??xxobLLINi&Kv6 zDz^n*4-$LzKbirJsCXGAJ>fy`86z`ndP-yM&b#_GA_WDq2=fOV)Hm zJv1-07!dqdXHK~GDe$b_spGb^Hn46PhT)=jF2wlD=^LypjE=TK;tk_ojhUZlDA&$R zuUP}dpGuGA7r2D&RDGwL+JAOFOboiQTW}p<<;b#L4^QZqpJ$t+;}_@8J7J=-)?-V{ z7cYKlJ*4oK7cqaGfNm94;s+TSy_8B2TSrTsy`MP2G12jrw|nM$DD2)Uk@8Ewrrlq` zwSl;0mWN77siKDdDjYUX-b+zDd6aKAU$Gn3Wka-y%V`iD5w- zJ7d+RfSR*KEmEm0+Qjla$x7Szc_t({%&m5^Ql65(w>({y*oM%8>xLSa+z0mx#+>l8 zC?YhgJ>)klvpbF(gCmqi3dWO7By|-?!lEjastbt5s={}@nzGo!OI>}9t zdzAgAmqy{)t$TYrwLvDA((R%@O&CefR@_KEhhnTyfcri^WP_ARK2YB5{7c(XB#26Ra?31lScZM}~M zz2jP(V*`4^q*Yza1{fI4gm)YZwJJPwbtiVn64|cUImsKwf-}QelqqL@aK^PhZB#Dt zRh7#;b}t$`1G=00-g1s!easa>c9ZmE%x^-@!UK4EB4+Z)pXC?6yz;uj78I+P{9K{s zYjSTHV`o%pnPCZF)i>tzqbc^W>=>4hykpsU9aV&Of*W-VZa>~%^J$B`Z^~ClvFxm$ zSn=`Xh~lzmZ`en%VJ-5&<#4fL=U~3qyrbn@6Yl}b3g$dLu@hv5r+X};<#y$}uq?5{ z#|K_2_86CMRbQ=Z`D(txK6)iJq(G)>;jYGKQECz8?8-{bxWXn!#tXDJxhGkP9RbY+ zKyU3PfG0pM%*xy;RaJ{;L?mY;8lwvRP{1-ifq%pZy1sQJ3Zxc@?A}#xMA*9KF$8FKAnIOQ1VmM=WoVe2rhvpBy*K= zD-4Il*G3f{Toi!T*=)irptEK6MDegxIHj-wD%1`d)!_@PQm=eN4*pmvf7{$GeYHW@U42p! zq!|3PRIKa_-}ElO=##}P?8}LDt%@y2jhCdYSc@W0@C}>On-|r|&Cq*~U70IsDecm8 z*M@lHZ5M&4a*qpI?I7=p(ibX-P9ur(TvYhlF&}0 zP?frbnC;jyDFAUI_CmH9I`p!;{@0FC6g;(B*Bsj#P}3zRzi-Ri!|hv5y1Zcze7sfX``#a@Rl8ed`pu<@51s zQJpCY%NqW^BbO>56Q6C(4%E+~xsnk>{jh_(-fhZfSt!$k@W`JZ<$bJIsC~KMo+X;n z<*xikWA+#uo~#lUJ=JfFu~$v;WvbtAzUOOCUVM}Z-D4xF3`~U!hVi*+-<}*OOGwY4 z@w+Epr%=dC-AoVZAG!wRFB%)*_{Q1u^ciZ5f9#W^^0kvK-)v4}M#DZh)lS7JW_;44 zhB?|{;=9>|-0Pp@h}|lbykl^Q^28a>(LLq&H1R=GrJL%FB#LsMafTKjoh`wW(?cRY zF0(gW)^n!@sXz`d!qILvC%yB&n_WB6t^ht8I(x!ts*xBLG7m zy@;YSglf{<%tFX3Zka%%TO z47I1D)Us~gqV%KvE{=`~N0bfXh3sla|JXaDjaZ2@{RTqONk#88<0H?FU*oJF*GoJu zcvHHp44=>n@&!KRoO8HaB7kq4OCd6@B1r~cJ4Y{@uP0TPucDbn7M9^hfgpY$GIby-om<}q*C#A#1IXm%E4>;~@2U^gd`>gs^v)5CR zDuCb2T^tL#5dL?Dl~w9pZ)-xUCo+o36t=o})BWj#^B_1)IT^M3c5lwH4CRVV+!&aS zDHOGQR`YjBw8(CK_T*-zNpGuLxy|}qjh`M}t^TXni9bAt zLb&MOXh)+({*-E|=<9mEtYP$4;ocPwr?HB(CDyXj*r0EHm)I8^2f>-@OpsxVhPKrX ztWi*1(;Pj8f%b6@omyhzNk~e0vN`Y=O8w1Ki+OsMa1Pb`n8{-Weheku>mw~+*<;dS zpEjf~?x0Kxmt{Ys`T8)ttuM!pzHV|c$nO`USrRZPdO5<0ut+$|BX9l?SQw*|Nah=O zabj((`?_pg>^YRA8f~=^=fVWBQkiug3>WQAAy6%KNM<%#>9C1}HkT%V6G_i|oM zd6${+EPo?+{=-7)_?&YJ#X5D=3du%Kw~3ZrUD~J`Tj&&yy#D%T)4SNeH@Hc~p*$$n z*}9as23E@c64|75g;3ErAOokuskrZvl_PbUQ%i%$i{&1*{tjkrVjm1gmQ^BElq(6T zRSktVR*VJ8k5i5za+GbrLpY)(G|TqGz?Of+eUY=6#35RUjNDx8pn>A$m&5sJ`^F0; z!>#Y+8>t;+ZZ73GuGf3;DXvx*xk|yy1!{Qa}A@M5?8SA@r1zt3Ht4?Wcc-Rdd8a9ruT?xE)A8| zFNU==x|AZ5vO3i{;!~*zUKXpgZNUypfcA5|I@{bqCQ5+lgrIM|SC-8g5iB)BZE_MN z?XTxo#4_5Lgc$}zoW*vi?B?5gXd+c#qX~ACYNxDw2kP%|m{Maw%G!#xJv#P=u&eb| zCb_)TK^2x6BFa^3q%^@=aFZaFb#j+ZNG|yNNmQC}DhG461E_eS#MX`wgwe3aJ2-AN zQx|4*DjB_1eW37CD*Ewqv7l2(i6G?hZRN|`Vw>8Ulri{k&H8ej82S`Ecyq*w!h&Cu zy+bGNiAUUeN?46jK*0Um*c*A3Icw2MmV|CB#6_^OpjLFd#nTp4I!S!8Oq>o-cc-j; z$62Y}xVT8qsUCF2?h9E2)t&a}-kJK)>cxvNNV}a(KfwGp!rh3s0g`B487}z=IUGiG#xOr9WoK@wYRN&)7t(u0Euz=InFrP z9S%aEKL;W}AP_1Ihx~%2|Cy56jvYumqel(g!Gg)v=xk zH0CI7@UMVDhd(7DP%v0l=07$+wZKPOU^yrR4E>MI4=qC=__tVK|3T?d8GbLxZ^0QL z@Hq4lsgiO>#7cl9WnnTPxkD=95J`wM3B`Iv;ey7v{$%RV#ZTnOAmk_hqaq$y zoS7HG8To(6{6~((x%eEol>tji!)4@TVL%y>BpeI^!w#F`zfdSt@(6MG&CD;hfwI2} z|5I?#t_Or1*vI1t$REqEbN{OY!T;HTK1bQ=p?^ep)VIGHjd0kMzZsDG&4Aj$wZda@ zKv8D|8ixgfCFLZ+AfTul9`7YDC3OV4;t*bLXlEZuEY9`(`5!gGVOF28JG(K9XR5VNfVY z_Wxp_gVOw=2a$vRfyqH-{=i^=+Jnl1{?LO-ga5DxJGdzSVt5<^?SaG{v0#P{Kpy6H obY-zvJP`iRJ3$A7!UE-fvEhS9;P6LWz#s>&Jz-%DBTc~n0QwZ5yZ`_I 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()) -- 2.47.3