From 7b743c38b99d6dfc5021b5f19c2533cf6daa7b3c Mon Sep 17 00:00:00 2001 From: coretl Date: Wed, 11 Sep 2024 08:05:57 +0000 Subject: [PATCH] deploy: e96a449598b595385c64afe11be03854a326f1cd --- main/.buildinfo | 2 +- main/.doctrees/_api.doctree | Bin 0 -> 4966 bytes .../python_copier_template_example.doctree | Bin 0 -> 5434 bytes main/.doctrees/reference.doctree | Bin 3532 -> 3562 bytes main/_api.html | 564 ++++++++++++++++ main/_api/python_copier_template_example.html | 610 ++++++++++++++++++ main/_sources/_api.rst.txt | 16 + .../python_copier_template_example.rst.txt | 13 + main/_sources/reference.md.txt | 2 +- main/_static/documentation_options.js | 2 +- main/explanations.html | 4 +- main/explanations/decisions.html | 4 +- .../0001-record-architecture-decisions.html | 4 +- ...02-switched-to-python-copier-template.html | 4 +- main/genindex.html | 25 +- main/how-to.html | 4 +- main/how-to/contribute.html | 4 +- main/how-to/run-container.html | 4 +- main/index.html | 6 +- main/objects.inv | Bin 577 -> 566 bytes main/py-modindex.html | 6 +- main/reference.html | 14 +- main/search.html | 4 +- main/searchindex.js | 2 +- main/tutorials.html | 4 +- main/tutorials/installation.html | 4 +- 26 files changed, 1255 insertions(+), 47 deletions(-) create mode 100644 main/.doctrees/_api.doctree create mode 100644 main/.doctrees/_api/python_copier_template_example.doctree create mode 100644 main/_api.html create mode 100644 main/_api/python_copier_template_example.html create mode 100644 main/_sources/_api.rst.txt create mode 100644 main/_sources/_api/python_copier_template_example.rst.txt diff --git a/main/.buildinfo b/main/.buildinfo index b8b00c7..7efdbb3 100644 --- a/main/.buildinfo +++ b/main/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 79a135f7b8f81af4bf21108fc300a276 +config: 2ea0ac55bce27938c54f0509d194415f tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/main/.doctrees/_api.doctree b/main/.doctrees/_api.doctree new file mode 100644 index 0000000000000000000000000000000000000000..b6f91c7ffbde49d35160f07afb8eebf7e5871e9f GIT binary patch literal 4966 zcmdT||8FBl6;Cd496Mi~>m5|Rqei8@Ty=?i6+$Sgico)QLrsOE3TTh*cz5jCWOrvf zGn?2tT`7V?jTnSbm*4n-zkxpii9f1B0zPkc*WNfyj!Ga@OSX63ym|BHefi9L`)T7( zAKYAUAG@Vf5hmk(76ge5xX$frApI=niOE0D@Bb=)lJDAV`(Qbv8(ue*&#^E}D;W(Xz`&d`u_*8fg49C-2ym6gGgj#JV0Z z+h)e75GKTt$aPC$py4Ll^dqJQ;VRB_GK zDbF+8G;BmGa?uvI#gc7#({RCPrHYbAJt1S>Q&|Gn^vRLBTF|#r?w;R9Udw zh7GcaDTH6->6H7mjSHQw6l#|pzuo@ur;i^#dHnj5>fdemgV}aA`JWp1;NkZU-l!$o zo4K=wycThsRW3H>g_Ra;*%dQV zGD|NRmmCiGiN2!cSFz+Q42;MR+vM9{z}O$apI(7~RXAPkx|)EW*9B1c4P-F6q$u=U zQu6E)-9;?2S$*k}7E+y!6iY>Ip?&8dogB!)@xe#eo4NbO_499j^r5r-F5-ASfbXcbi}<}mColnY(M3-6`yibV6`B*@Lli zKA+HkfYX0>UDn$b*aA2N^dTV1aV^p~W?_%2RyAi zfM1y^r1r1HJ@HpSCdv7fmR)CcTJQ-NA7jH`&gJ88swOUd7HH};>y!@MP??=Ox_ngU|Cs}OGUsIpaj0(| zfw-F*A&??STsNX2>V<;BBToH^_Rc~hys9w9PUV8KQieekPo*-RD@~AOwk=pR9X4zS z9SZDcn8|d-)Ub_!53&)q+a$cFOB8ZBi$Q6@5k9BGkbYqTYk55JC0(_+Pck#y`~IE| z@qFjvq{o$#$`j~bBCcS2Qq{*bu~pc-CZ*w|&#F8RD3*NElS1 zAXe-qp@=sl*&87OZ6nCy)SCt)4C@FX;!q_F@YlCnj^e_cygwtQnrDIZ(9M8r8~3r) z+^es2QQ{l#G}NJS!Mf!Ip{6nx2Pw5|R!M?{TgPEE(!ymNgl?2<-V~#5(-Ss9&*ZX_ zCnPO^%hv!ea8)rpT(lj^G(-+SSs?mjR0{8I-?N)3PdzFhke|LY80xVU(GJ}yDeO0e zF{wW2^+4A9MUk{G)d;zCi#VME;GDL<)Wq?0@8#FN3wv&=p+6^{C^PY|RN|4gj6(K= ztNoChq1yvc&=V$(uvrUt39`sl&a3t=Vlwuo$vHg$8X=01bGxl4iD6?;gd-8*>l!)S zNV#3t=;@93afYncFw{*qE{0wteOAK%U08F9p*`nkckI8Kn72sf#9gj&h0H9Tqhn!Emw0lT$y8n3Xx^-HU(H7 zP$!Q5e&+(U=+;4owBd9>l_@p)pf`zFJRiS^6hFR$A8lJirt*}S+{C#S&*PD%#RF|O z>V9*QHc+@0*9xQ;6iUyEuTZ&8p_p=1_&FY+0lvWc+#GSr-MYZms&;jfb}q;V(khc9 zZ*I-YDra!j0X%$}5j5alL2(qp$S^1Fu;yDO{d1V$Y5o%=0{SVW6kdjC_YMf}Ms}tc ea)G=yB|G=6m1POSWkhdO+5y2_i3mlBxc_f|SA!}5 literal 0 HcmV?d00001 diff --git a/main/.doctrees/_api/python_copier_template_example.doctree b/main/.doctrees/_api/python_copier_template_example.doctree new file mode 100644 index 0000000000000000000000000000000000000000..7f1fa28856ff5844dc16f0b554c3d9a43d265f74 GIT binary patch literal 5434 zcmdT|&u=6-6;3AU?sR@mW+s5h4m7jukX=ak9uT{P6GCFNL_`R!RzhgyaaXz9PO8g= z%awE_R)WJW6Xe^P1LA=8$_eowApQg{{1XUij|d??+f~)o$#k+vT!_?B*?zX4-}~P8 zp8bo~Zw7ly{?F{>85ilaPvbb1G0Ux4i)BIDteL2LPgA)B}hbE zB(Y+teczgGC$2@3_sjX6oJCs5w4Tmeyv;lB+XLP;EiH7y8bjvE^XJ*6<}xLb%mhokVD+XwsO@AC_aQ@3N`W*nH{s)$E5hoT;5roIqRtdDA8J zk@<>gmnS_jtBFXNJt>CNtW&L(7#129au!(;aqdpvi4vOU=)`v`rIYZr78lv9F{II% zVk0M0n2x4nH)Q!9@9|x%&A*BT`BR+m0KYfz`v!h}2=h1j4um%OSNIBlVtzj0a>53x zNK>W;7gC)K!dVZ4zSC8)%L%w8MB8}O!=>zZG zg~u=*m{|#LnFF($QK77PI+1aau?+Wsid+!m_vf?H%~*5C3a_u{ zJA!m^TahAfnJ?d=ZH1^i9lx zYnYNVb^)!{5UP~ut1-SOcJpdm)@`BinWJMb3;)e9{QRN7H&9whyvG!&;v$SbX zr{?dW=I^|*Y5u*q0-X7Nu*K|D ze_6a!^FT=HY!u506{$7%vP)z#bm+?rcxic1Sudig8Z&LfE@s1}v5ZAxBqDnSTD?39 zk$rdC1qv^Z!onxcntu)_WDBXKLdS1!qN6csOkLJQK8F9TS$CL|!&4L>c0L~3rJnq6 z{I9%i)<#8=ctmn#)`^x8L5k41#kl$iNB3Q&fKxZ+PeQann=@x(4}`!BkxX^7T&h{~ z2NjE&@4px5u$LB-AyYk?_ad4^g{yPo-te-=wa)UR!C)*jFNXa{PQdgT9pp?GnU*ri zNgho~%EO za{B=$8YE$_-06h3w5uDvS>{f6z@JqW@}jB{2QF<~NiM1j!CQ?|bsa`s2~Os3g=%rJ z7wRgTzhxe2MbjLi;Od1;$uZJZsIprcze89%mwBMsifx@(k1Jjm;&I)Z$_|A#xju{GVs-?1M01GVFxRIc- zp`_GMm5s#In&p8-YWCM7f_={*uwFI`m7uld_{H4<+$dCO1^1Z;BP@gb#u|e!%$B=9 zfhWjxB-O;eFx#$*%ix5GyOrfwa6k00g!vwF0oEYZO$7Uu6UwW}iP=;vlS&g`?Aqgd zW}VZdZnn%Wo1$pM>2#4-LM_vZ*{~R6yX_0AQkR3UE~69lbm5MOxg$CKL<*Y`Fp6}U z3hY_v(c#;No|0dgA0$jEsR*ZOoG{!2+D=ulwb==lZ>-Ytt61~++Q_vfPJikmZ#%3z z)1jLE%KX5!$>zR01F)BKm?-h((pEy#aY4rn7LSn*@8OQXqYclSqI%Y?kw&dpfA-J5w+(ey#kP|9|c@B%d*4Q-ux!)xvfUgwdGyU zZ23A%IU;wEJ!7gbm>&5(KnMe_CkZy|YC1#|#hTmWHS-vloRB&=>jRYK-j%tZU#6N) z2^V9Y;0OG!CelHFGoPT2AU`V*)j16H(6>XABoawKnD%kRaV3r5z7TJ)vNs`SpA{K0 zf_ql+ZzUxSTmd~Y66pvSD0$(5BZ|BjUK0}&huuWd5RC2-A8ChF>8TM5WYYna+*MFXc8(#{}8eZ zrGPArXCW|p?4CY8u;#&BudA(mH&z?f4VV1g%L>Fht}}d}_7UQzU&p`PbX~Vkc@Xjg zS2=%*7Zg8^oHxep<{8SIc3HYs++J5@^>fQJUpvlK#VwJeP_!?QUrs;4e*f3E_`+;8 zG3>3n6^U@2a&Z%S9930v!F|o1Acxm2V16=`NgWnm^wG7>TDm*8Vz=7WPkJ!7KC+I| z796s7eXVi?$sa@-$-EBikN96q!^1}UJB2fYAYIpQE}So7&z f_eS0Ap}Zl|C@EqWI%D^ow;nsnFWE6vmHqz!DMv)D literal 0 HcmV?d00001 diff --git a/main/.doctrees/reference.doctree b/main/.doctrees/reference.doctree index 8603d013ab9b988da6b9b095569a458af25d8e19..0081a2fc3cd586108f3f03df73c7a10f1085820a 100644 GIT binary patch delta 164 zcmX>j{YsjpfpzNrjVw&e+C9vU0iIKOl;aZ%GW828OEU8F;*;|WGEP*7ci%>X=DUsgr;uhWMOA!oU>VwU6qCL&SZ0LW5!#Pv$>@i zZ%=OLmS=o3c{#T!P~A`#j5j9tbBi**n(V@( mCX<(uUEIT&mzbMcQdy8%Jf(I@MqX!eh9Z#8-rUBM!UzBrRWG>! diff --git a/main/_api.html b/main/_api.html new file mode 100644 index 0000000..d119272 --- /dev/null +++ b/main/_api.html @@ -0,0 +1,564 @@ + + + + + + + + + + + API — python-copier-template-example 0.5.4.dev7+ge96a449 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
+
+
+
+ + + Ctrl+K +
+
+ +
+ +
+ + +
+
+ + + +
+ +
+ + + + + +
+ +
+ +
+ +
+ +
+
+ +
+ + +
+ +
+ + + +
+ + +
+ +
+ +
+ +
+
+ +
+ +
+ + +
+ + +
+ + + + + +
+ +
+ + +
+
+ + + + + +
+ + + +
+ + +
+ + + +
+
+ + +
+ + + +
+ +
+ +
+ +
+ +
+
+ +
+ +
+ + +
+
+ + + + +
+ +
+ + +
+
+ +
+
+ +
+ +
+ + + + +
+ +
+ + +
+
+ + + + + + + + + + + +
+ +
+
+
+ +
+ + + +
+ + +
+ + +
+ + + + + + Edit on GitHub + + + +
+
+ +
+ +
+ + Show Source + +
+
+ +
+ + +
+
+ +
+ +
+
+
+ + + + + + + + \ No newline at end of file diff --git a/main/_api/python_copier_template_example.html b/main/_api/python_copier_template_example.html new file mode 100644 index 0000000..957656a --- /dev/null +++ b/main/_api/python_copier_template_example.html @@ -0,0 +1,610 @@ + + + + + + + + + + + python_copier_template_example — python-copier-template-example 0.5.4.dev7+ge96a449 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
+
+
+
+ + + Ctrl+K +
+
+ +
+ +
+ + +
+
+ + + +
+ +
+ + + + + +
+ +
+ +
+ +
+ +
+
+ +
+ + +
+ +
+ + + +
+ + +
+ +
+ +
+ +
+
+ +
+ +
+ + +
+ + +
+ + + + + +
+ +
+ + +
+
+ + + +
+ + + +
+ + +
+ + + +
+
+ + +
+ + + +
+ +
+ +
+ +
+ +
+
+ +
+ +
+ +
+
+
+
+ + +
+
+ + + + +
+ +
+ + +
+
+ +
+
+ +
+ +
+ + + + +
+ +
+ + +
+
+ + + + + +
+ +
+

python_copier_template_example#

+

Top level API.

+
+
+python_copier_template_example.__version__: str#
+

Version number as calculated by pypa/setuptools_scm

+
+ +
+ + +
+ + + + + + + +
+ + + +
+ + +
+
+ On this page +
+
+ +
+ + +
+ + + + + + Edit on GitHub + + + +
+
+ +
+ +
+ + Show Source + +
+
+ +
+ + +
+
+ +
+ +
+
+
+ + + + + + + + \ No newline at end of file diff --git a/main/_sources/_api.rst.txt b/main/_sources/_api.rst.txt new file mode 100644 index 0000000..72f33bc --- /dev/null +++ b/main/_sources/_api.rst.txt @@ -0,0 +1,16 @@ +:orphan: + +.. + This page is not included in the TOC tree, but must exist so that the + autosummary pages are generated for python_copier_template_example and all its + subpackages + +API +=== + +.. autosummary:: + :toctree: _api + :template: custom-module-template.rst + :recursive: + + python_copier_template_example diff --git a/main/_sources/_api/python_copier_template_example.rst.txt b/main/_sources/_api/python_copier_template_example.rst.txt new file mode 100644 index 0000000..33eaab7 --- /dev/null +++ b/main/_sources/_api/python_copier_template_example.rst.txt @@ -0,0 +1,13 @@ +``python_copier_template_example`` +================================== + +.. automodule:: python_copier_template_example + :members: + + + + + + + + \ No newline at end of file diff --git a/main/_sources/reference.md.txt b/main/_sources/reference.md.txt index 1c8dc88..4aeadda 100644 --- a/main/_sources/reference.md.txt +++ b/main/_sources/reference.md.txt @@ -6,7 +6,7 @@ Technical reference material including APIs and release notes. :maxdepth: 1 :glob: -reference/* +API <_api/python_copier_template_example> genindex Release Notes ``` diff --git a/main/_static/documentation_options.js b/main/_static/documentation_options.js index 3dcd367..ac79bf5 100644 --- a/main/_static/documentation_options.js +++ b/main/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '0.5.4.dev6+gf94ad56', + VERSION: '0.5.4.dev7+ge96a449', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/main/explanations.html b/main/explanations.html index 11138e8..383bd94 100644 --- a/main/explanations.html +++ b/main/explanations.html @@ -8,7 +8,7 @@ - Explanations — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Explanations — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/explanations/decisions.html b/main/explanations/decisions.html index b964dad..4a288fe 100644 --- a/main/explanations/decisions.html +++ b/main/explanations/decisions.html @@ -8,7 +8,7 @@ - Architectural Decision Records — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Architectural Decision Records — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/explanations/decisions/0001-record-architecture-decisions.html b/main/explanations/decisions/0001-record-architecture-decisions.html index 7ebe4cb..f98552b 100644 --- a/main/explanations/decisions/0001-record-architecture-decisions.html +++ b/main/explanations/decisions/0001-record-architecture-decisions.html @@ -8,7 +8,7 @@ - 1. Record architecture decisions — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + 1. Record architecture decisions — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/explanations/decisions/0002-switched-to-python-copier-template.html b/main/explanations/decisions/0002-switched-to-python-copier-template.html index d89ce1d..ab5045d 100644 --- a/main/explanations/decisions/0002-switched-to-python-copier-template.html +++ b/main/explanations/decisions/0002-switched-to-python-copier-template.html @@ -8,7 +8,7 @@ - 2. Adopt python-copier-template for project structure — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + 2. Adopt python-copier-template for project structure — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/genindex.html b/main/genindex.html index a826f44..8a6f942 100644 --- a/main/genindex.html +++ b/main/genindex.html @@ -7,7 +7,7 @@ - Index — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Index — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -37,7 +37,7 @@ - + @@ -420,7 +420,7 @@ aria-label="Section Navigation">

Section Navigation

@@ -455,10 +455,19 @@

Index

- M + _ + | M | P
+

_

+ + +
+

M

@@ -479,14 +488,10 @@

P

python_copier_template_example -
diff --git a/main/how-to.html b/main/how-to.html index 3d1c0ee..ec152be 100644 --- a/main/how-to.html +++ b/main/how-to.html @@ -8,7 +8,7 @@ - How-to Guides — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + How-to Guides — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/how-to/contribute.html b/main/how-to/contribute.html index 980bd89..b7a7490 100644 --- a/main/how-to/contribute.html +++ b/main/how-to/contribute.html @@ -8,7 +8,7 @@ - Contribute to the project — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Contribute to the project — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/how-to/run-container.html b/main/how-to/run-container.html index 1c2470f..03e8c7f 100644 --- a/main/how-to/run-container.html +++ b/main/how-to/run-container.html @@ -8,7 +8,7 @@ - Run in a container — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Run in a container — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/index.html b/main/index.html index ab2c128..14dff39 100644 --- a/main/index.html +++ b/main/index.html @@ -8,7 +8,7 @@ - python_copier_template_example — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + python_copier_template_example — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + @@ -556,7 +556,7 @@

How the documentation is structured
  • Reference diff --git a/main/objects.inv b/main/objects.inv index 1961d5c03e69f3acc8ab0097e873b46faf96adeb..f23a5355c998ff0304c7419e18bf2900d10654df 100644 GIT binary patch delta 429 zcmV;e0aE_K1hxc_lYdXcFbuxuS6G5;){P@K1PFFOnt*#15<`Q!BuZV_{yk~kt}TzP z+!FhH__NZ6Jr&;N+6Rj4XsWms@Y@bXr2Lg3ZEF{Gy<3dBzNR4pN+e z=lKW5$|gkKSQ$kMR`ZP-hXxE4nM>m}NG7*kxZ14645{zrIe*S@93ya-?oLrkR*m(? zbr!lERVK8|ptjX9fdSFwjk>Uen(C-Zxapekh}uW|+P7^wyYl>hLbA;KfB z7Tq{7M!^AfWXKCyeOl558cAOA{w42U_WPeV=^P~<_hJE8#s`8w>|T9@5dC|Kk*s6g zrV(%GtTVV9Pk+ Xt|C>I?L+;QIzjaBXQ+rT`ZFP$w@%ko delta 440 zcmV;p0Z0C}1i=K5lYej9FbuxyR}fgQijy9D3$|hFVL;IBZm1GlYj7k%rrYG-Pc|bz zR@Y5$Hu=3MnGR>FyeqX27Gp_x47DOG@ubodLO918DT*tM`N`cMtu@$Ou!Z)HqJ3=VqrPdf!q*X;gs8%tHLJz88_AKf z4&#F0tk0Sctpn>o!B7`(W}OVWzEdJC=g6+rBi0>1oMmpX$}iq;KD9~r1KOcC|DV13 zGnol4?Dq0^ATwQxfipdjp?EpN{3>P+i;Te<_J@1XU@^Bg^ORg;%x~@=)H4cd$w#Z| i+4>Ge#{bE$Bf7AzAywD?;w(~Ui2OZ|74Z+B0vKU+gx#+I diff --git a/main/py-modindex.html b/main/py-modindex.html index 03c6c14..3d0c158 100644 --- a/main/py-modindex.html +++ b/main/py-modindex.html @@ -7,7 +7,7 @@ - Python Module Index — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Python Module Index — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -37,7 +37,7 @@ - + @@ -460,7 +460,7 @@

    Python Module Index

    - python_copier_template_example + python_copier_template_example diff --git a/main/reference.html b/main/reference.html index 126eead..2a456c4 100644 --- a/main/reference.html +++ b/main/reference.html @@ -8,7 +8,7 @@ - Reference — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Reference — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + @@ -54,7 +54,7 @@ - + @@ -427,7 +427,7 @@ aria-label="Section Navigation">

    Section Navigation

    @@ -489,7 +489,7 @@

    Reference @@ -516,11 +516,11 @@

    Reference

    next

    -

    API

    +

    python_copier_template_example

     diff --git a/main/search.html b/main/search.html index b6d3ad2..c52ab58 100644 --- a/main/search.html +++ b/main/search.html @@ -6,7 +6,7 @@ - Search - python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Search - python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -36,7 +36,7 @@ - + diff --git a/main/searchindex.js b/main/searchindex.js index 223ab4d..7ccca93 100644 --- a/main/searchindex.js +++ b/main/searchindex.js @@ -1 +1 @@ -Search.setIndex({"alltitles": {"1. Record architecture decisions": [[2, null]], "2. Adopt python-copier-template for project structure": [[3, null]], "API": [[10, null]], "Architectural Decision Records": [[1, null]], "Check your version of python": [[12, "check-your-version-of-python"]], "Code Coverage": [[6, "code-coverage"]], "Consequences": [[2, "consequences"], [3, "consequences"]], "Context": [[2, "context"], [3, "context"]], "Contribute to the project": [[6, null]], "Create a virtual environment": [[12, "create-a-virtual-environment"]], "Decision": [[2, "decision"], [3, "decision"]], "Developer Information": [[6, "developer-information"]], "Explanations": [[0, null]], "How the documentation is structured": [[8, "how-the-documentation-is-structured"]], "How-to Guides": [[5, null]], "Index": [[4, null]], "Installation": [[12, null]], "Installing the library": [[12, "installing-the-library"]], "Issue or Discussion?": [[6, "issue-or-discussion"]], "Reference": [[9, null]], "Run in a container": [[7, null]], "Starting the container": [[7, "starting-the-container"]], "Status": [[2, "status"], [3, "status"]], "Tutorials": [[11, null]], "python_copier_template_example": [[8, null], [10, "python-copier-template-example"]]}, "docnames": ["explanations", "explanations/decisions", "explanations/decisions/0001-record-architecture-decisions", "explanations/decisions/0002-switched-to-python-copier-template", "genindex", "how-to", "how-to/contribute", "how-to/run-container", "index", "reference", "reference/api", "tutorials", "tutorials/installation"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["explanations.md", "explanations/decisions.md", "explanations/decisions/0001-record-architecture-decisions.md", "explanations/decisions/0002-switched-to-python-copier-template.md", "genindex.md", "how-to.md", "how-to/contribute.md", "how-to/run-container.md", "index.md", "reference.md", "reference/api.md", "tutorials.md", "tutorials/installation.md"], "indexentries": {"module": [[10, "module-python_copier_template_example", false]], "python_copier_template_example": [[10, "module-python_copier_template_example", false]], "python_copier_template_example.__version__ (in module python_copier_template_example)": [[10, "python_copier_template_example.python_copier_template_example.__version__", false]]}, "objects": {"": [[10, 0, 0, "-", "python_copier_template_example"]], "python_copier_template_example.python_copier_template_example": [[10, 1, 1, "", "__version__"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:data"}, "terms": {"": [1, 2, 6], "1": 1, "10": 12, "100": 6, "2": 1, "3": 12, "As": [1, 3], "For": [1, 6], "If": [6, 8, 12], "It": [6, 12], "Or": 8, "The": [3, 12], "To": [2, 7], "__version__": [8, 10], "abov": 2, "accept": [2, 3], "access": 8, "activ": 12, "adopt": 1, "adr": [1, 2], "all": [6, 8], "alreadi": 7, "also": [6, 8, 12], "an": 8, "ani": [6, 12], "api": [8, 9], "ar": [1, 6, 7], "architectur": [0, 8], "articl": 2, "ask": 6, "avail": 7, "bar": 8, "been": 12, "befor": 6, "below": 1, "big": 6, "bin": 12, "blog": 1, "bug": 6, "built": 7, "calcul": 10, "can": [3, 6, 12], "categori": 8, "caught": 6, "cd": 3, "chang": [3, 6], "check": 6, "ci": 3, "close": 6, "code": 8, "com": [8, 12], "command": 8, "commandlin": [8, 12], "commit": 6, "common": 6, "configur": 6, "consist": 3, "contain": [5, 6, 8], "container": 6, "contribut": [5, 8], "copi": 2, "copier": [1, 6, 7, 8, 12], "could": 3, "creat": [2, 6], "current": 12, "decis": [0, 8], "depend": [7, 12], "describ": [2, 8], "devcontain": 6, "develop": 3, "diamond": 6, "diamondlightsourc": [7, 8, 12], "differ": 3, "dl": [8, 12], "docker": [7, 8], "doe": [6, 8], "don": 6, "easili": 6, "enabl": 8, "end": 6, "ensur": 3, "environ": [3, 6], "exampl": [7, 8, 12], "exist": [2, 6, 12], "expand": 8, "experienc": [5, 8], "explan": 8, "f": 8, "featur": 12, "file": 6, "fit": 6, "fix": 3, "follow": 3, "format": 3, "four": 8, "free": 6, "from": [2, 3, 7, 8, 12], "get": 7, "ghcr": [7, 8], "git": 12, "github": [6, 7, 8, 12], "great": 6, "guid": [6, 8], "ha": 12, "handl": 6, "have": [3, 6], "hello": 8, "here": [8, 11], "hook": 6, "how": [0, 6], "http": [8, 12], "i": [6, 10, 12], "idea": 6, "illustr": 8, "imag": 8, "import": 8, "improv": 6, "includ": [8, 9], "index": [8, 9], "inform": 1, "instal": [7, 8, 11], "instead": [6, 7], "interfac": 12, "interfer": 12, "intern": 10, "introductori": 8, "involv": 6, "io": [7, 8], "its": [6, 7, 12], "keep": 1, "later": 12, "latest": [3, 7, 8], "librari": [6, 8], "lifetim": 1, "light": 6, "like": 6, "link": [2, 8], "lint": 3, "list": 1, "look": 8, "m": [8, 12], "made": [1, 2], "mai": 3, "make": 6, "manag": 3, "materi": [8, 9], "michael": [1, 2], "might": [6, 8], "modul": [3, 8], "more": [1, 5, 6, 8], "most": 6, "need": [2, 6, 12], "new": [2, 6, 8, 11], "note": [8, 9], "now": 12, "number": [6, 7, 10], "nygard": [1, 2], "obviou": 6, "offer": 6, "one": 6, "ones": 2, "open": 6, "option": 8, "own": 6, "packag": 3, "paragraph": 8, "past": 2, "path": 12, "peopl": 8, "pip": [3, 8, 12], "place": 6, "pleas": 6, "practic": [5, 8], "pre": [6, 7], "print": 8, "project": [1, 2, 5, 8], "pull": [3, 6, 7], "put": 8, "pypa": 10, "pypi": 8, "python": [1, 6, 7, 8], "python3": 12, "question": 6, "rais": 6, "recommend": [6, 12], "record": [0, 8], "reduc": 6, "refer": [8, 10], "registri": 7, "releas": [7, 8, 9, 12], "relev": 8, "remain": 6, "repositori": 6, "request": 6, "requir": 12, "run": [5, 6, 8], "same": 6, "scope": 6, "see": [1, 2, 6], "set": [3, 6], "setup": 3, "setuptools_scm": 10, "share": 6, "short": 8, "should": [3, 8, 12], "significantli": 6, "snippet": 8, "so": 12, "softwar": 12, "some": 8, "someth": 6, "sourc": [6, 8, 12], "spend": 6, "split": 8, "start": [8, 11], "step": [5, 8], "str": 10, "structur": 1, "suit": 6, "sure": 6, "switch": 3, "t": 6, "task": 6, "technic": [8, 9], "techniqu": 3, "templat": [1, 6, 7, 8, 12], "termin": 12, "test": 6, "thi": [1, 2, 3, 6, 8, 10, 12], "through": 6, "throughout": 1, "ticket": 6, "time": 6, "tool": [3, 8], "top": 8, "track": 1, "tutori": 8, "type": 12, "typic": [8, 11], "up": 6, "updat": 3, "us": [2, 3, 6, 7, 8, 12], "usag": [8, 11], "user": [5, 8, 11], "venv": [3, 12], "version": [7, 8, 10], "vscode": 6, "wa": 6, "wai": [0, 1, 8], "want": 6, "we": [1, 2, 3, 6], "welcom": 6, "what": 8, "when": 6, "where": 8, "while": 6, "why": [0, 8], "work": [0, 8], "write": 8, "you": [6, 8, 12], "your": [6, 8]}, "titles": ["Explanations", "Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python-copier-template for project structure", "Index", "How-to Guides", "Contribute to the project", "Run in a container", "python_copier_template_example", "Reference", "API", "Tutorials", "Installation"], "titleterms": {"1": 2, "2": 3, "adopt": 3, "api": 10, "architectur": [1, 2], "check": 12, "code": 6, "consequ": [2, 3], "contain": 7, "context": [2, 3], "contribut": 6, "copier": 3, "coverag": 6, "creat": 12, "decis": [1, 2, 3], "develop": 6, "discuss": 6, "document": 8, "environ": 12, "explan": 0, "guid": 5, "how": [5, 8], "i": 8, "index": 4, "inform": 6, "instal": 12, "issu": 6, "librari": 12, "project": [3, 6], "python": [3, 12], "python_copier_template_exampl": [8, 10], "record": [1, 2], "refer": 9, "run": 7, "start": 7, "statu": [2, 3], "structur": [3, 8], "templat": 3, "tutori": 11, "version": 12, "virtual": 12, "your": 12}}) \ No newline at end of file +Search.setIndex({"alltitles": {"1. Record architecture decisions": [[4, null]], "2. Adopt python-copier-template for project structure": [[5, null]], "API": [[0, null]], "Architectural Decision Records": [[3, null]], "Check your version of python": [[13, "check-your-version-of-python"]], "Code Coverage": [[8, "code-coverage"]], "Consequences": [[4, "consequences"], [5, "consequences"]], "Context": [[4, "context"], [5, "context"]], "Contribute to the project": [[8, null]], "Create a virtual environment": [[13, "create-a-virtual-environment"]], "Decision": [[4, "decision"], [5, "decision"]], "Developer Information": [[8, "developer-information"]], "Explanations": [[2, null]], "How the documentation is structured": [[10, "how-the-documentation-is-structured"]], "How-to Guides": [[7, null]], "Index": [[6, null]], "Installation": [[13, null]], "Installing the library": [[13, "installing-the-library"]], "Issue or Discussion?": [[8, "issue-or-discussion"]], "Reference": [[11, null]], "Run in a container": [[9, null]], "Starting the container": [[9, "starting-the-container"]], "Status": [[4, "status"], [5, "status"]], "Tutorials": [[12, null]], "python_copier_template_example": [[1, null], [10, null]]}, "docnames": ["_api", "_api/python_copier_template_example", "explanations", "explanations/decisions", "explanations/decisions/0001-record-architecture-decisions", "explanations/decisions/0002-switched-to-python-copier-template", "genindex", "how-to", "how-to/contribute", "how-to/run-container", "index", "reference", "tutorials", "tutorials/installation"], "envversion": {"sphinx": 63, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx.ext.viewcode": 1}, "filenames": ["_api.rst", "_api/python_copier_template_example.rst", "explanations.md", "explanations/decisions.md", "explanations/decisions/0001-record-architecture-decisions.md", "explanations/decisions/0002-switched-to-python-copier-template.md", "genindex.md", "how-to.md", "how-to/contribute.md", "how-to/run-container.md", "index.md", "reference.md", "tutorials.md", "tutorials/installation.md"], "indexentries": {"__version__ (in module python_copier_template_example)": [[1, "python_copier_template_example.__version__", false]], "module": [[1, "module-python_copier_template_example", false]], "python_copier_template_example": [[1, "module-python_copier_template_example", false]]}, "objects": {"": [[1, 0, 0, "-", "python_copier_template_example"]], "python_copier_template_example": [[1, 1, 1, "", "__version__"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "data", "Python data"]}, "objtypes": {"0": "py:module", "1": "py:data"}, "terms": {"": [3, 4, 8], "1": 3, "10": 13, "100": 8, "2": 3, "3": 13, "As": [3, 5], "For": [3, 8], "If": [8, 10, 13], "It": [8, 13], "Or": 10, "The": [5, 13], "To": [4, 9], "__version__": [1, 10], "abov": 4, "accept": [4, 5], "access": 10, "activ": 13, "adopt": 3, "adr": [3, 4], "all": [8, 10], "alreadi": 9, "also": [8, 10, 13], "an": 10, "ani": [8, 13], "api": [1, 10, 11], "ar": [3, 8, 9], "architectur": [2, 10], "articl": 4, "ask": 8, "avail": 9, "bar": 10, "been": 13, "befor": 8, "below": 3, "big": 8, "bin": 13, "blog": 3, "bug": 8, "built": 9, "calcul": 1, "can": [5, 8, 13], "categori": 10, "caught": 8, "cd": 5, "chang": [5, 8], "check": 8, "ci": 5, "close": 8, "code": 10, "com": [10, 13], "command": 10, "commandlin": [10, 13], "commit": 8, "common": 8, "configur": 8, "consist": 5, "contain": [7, 8, 10], "container": 8, "contribut": [7, 10], "copi": 4, "copier": [3, 8, 9, 10, 13], "could": 5, "creat": [4, 8], "current": 13, "decis": [2, 10], "depend": [9, 13], "describ": [4, 10], "devcontain": 8, "develop": 5, "diamond": 8, "diamondlightsourc": [9, 10, 13], "differ": 5, "dl": [10, 13], "docker": [9, 10], "doe": [8, 10], "don": 8, "easili": 8, "enabl": 10, "end": 8, "ensur": 5, "environ": [5, 8], "exampl": [9, 10, 13], "exist": [4, 8, 13], "expand": 10, "experienc": [7, 10], "explan": 10, "f": 10, "featur": 13, "file": 8, "fit": 8, "fix": 5, "follow": 5, "format": 5, "four": 10, "free": 8, "from": [4, 5, 9, 10, 13], "get": 9, "ghcr": [9, 10], "git": 13, "github": [8, 9, 10, 13], "great": 8, "guid": [8, 10], "ha": 13, "handl": 8, "have": [5, 8], "hello": 10, "here": [10, 12], "hook": 8, "how": [2, 8], "http": [10, 13], "i": [8, 13], "idea": 8, "illustr": 10, "imag": 10, "import": 10, "improv": 8, "includ": [10, 11], "index": [10, 11], "inform": 3, "instal": [9, 10, 12], "instead": [8, 9], "interfac": 13, "interfer": 13, "introductori": 10, "involv": 8, "io": [9, 10], "its": [8, 9, 13], "keep": 3, "later": 13, "latest": [5, 9, 10], "level": 1, "librari": [8, 10], "lifetim": 3, "light": 8, "like": 8, "link": [4, 10], "lint": 5, "list": 3, "look": 10, "m": [10, 13], "made": [3, 4], "mai": 5, "make": 8, "manag": 5, "materi": [10, 11], "michael": [3, 4], "might": [8, 10], "modul": [5, 10], "more": [3, 7, 8, 10], "most": 8, "need": [4, 8, 13], "new": [4, 8, 10, 12], "note": [10, 11], "now": 13, "number": [1, 8, 9], "nygard": [3, 4], "obviou": 8, "offer": 8, "one": 8, "ones": 4, "open": 8, "option": 10, "own": 8, "packag": 5, "paragraph": 10, "past": 4, "path": 13, "peopl": 10, "pip": [5, 10, 13], "place": 8, "pleas": 8, "practic": [7, 10], "pre": [8, 9], "print": 10, "project": [3, 4, 7, 10], "pull": [5, 8, 9], "put": 10, "pypa": 1, "pypi": 10, "python": [3, 8, 9, 10], "python3": 13, "question": 8, "rais": 8, "recommend": [8, 13], "record": [2, 10], "reduc": 8, "refer": 10, "registri": 9, "releas": [9, 10, 11, 13], "relev": 10, "remain": 8, "repositori": 8, "request": 8, "requir": 13, "run": [7, 8, 10], "same": 8, "scope": 8, "see": [3, 4, 8], "set": [5, 8], "setup": 5, "setuptools_scm": 1, "share": 8, "short": 10, "should": [5, 10, 13], "significantli": 8, "snippet": 10, "so": 13, "softwar": 13, "some": 10, "someth": 8, "sourc": [8, 10, 13], "spend": 8, "split": 10, "start": [10, 12], "step": [7, 10], "str": 1, "structur": 3, "suit": 8, "sure": 8, "switch": 5, "t": 8, "task": 8, "technic": [10, 11], "techniqu": 5, "templat": [3, 8, 9, 10, 13], "termin": 13, "test": 8, "thi": [3, 4, 5, 8, 10, 13], "through": 8, "throughout": 3, "ticket": 8, "time": 8, "tool": [5, 10], "top": [1, 10], "track": 3, "tutori": 10, "type": 13, "typic": [10, 12], "up": 8, "updat": 5, "us": [4, 5, 8, 9, 10, 13], "usag": [10, 12], "user": [7, 10, 12], "venv": [5, 13], "version": [1, 9, 10], "vscode": 8, "wa": 8, "wai": [2, 3, 10], "want": 8, "we": [3, 4, 5, 8], "welcom": 8, "what": 10, "when": 8, "where": 10, "while": 8, "why": [2, 10], "work": [2, 10], "write": 10, "you": [8, 10, 13], "your": [8, 10]}, "titles": ["API", "python_copier_template_example", "Explanations", "Architectural Decision Records", "1. Record architecture decisions", "2. Adopt python-copier-template for project structure", "Index", "How-to Guides", "Contribute to the project", "Run in a container", "python_copier_template_example", "Reference", "Tutorials", "Installation"], "titleterms": {"1": 4, "2": 5, "adopt": 5, "api": 0, "architectur": [3, 4], "check": 13, "code": 8, "consequ": [4, 5], "contain": 9, "context": [4, 5], "contribut": 8, "copier": 5, "coverag": 8, "creat": 13, "decis": [3, 4, 5], "develop": 8, "discuss": 8, "document": 10, "environ": 13, "explan": 2, "guid": 7, "how": [7, 10], "i": 10, "index": 6, "inform": 8, "instal": 13, "issu": 8, "librari": 13, "project": [5, 8], "python": [5, 13], "python_copier_template_exampl": [1, 10], "record": [3, 4], "refer": 11, "run": 9, "start": 9, "statu": [4, 5], "structur": [5, 10], "templat": 5, "tutori": 12, "version": 13, "virtual": 13, "your": 13}}) \ No newline at end of file diff --git a/main/tutorials.html b/main/tutorials.html index bf8adc7..94d6cb8 100644 --- a/main/tutorials.html +++ b/main/tutorials.html @@ -8,7 +8,7 @@ - Tutorials — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Tutorials — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - + diff --git a/main/tutorials/installation.html b/main/tutorials/installation.html index 592c976..38a3ebd 100644 --- a/main/tutorials/installation.html +++ b/main/tutorials/installation.html @@ -8,7 +8,7 @@ - Installation — python-copier-template-example 0.5.4.dev6+gf94ad56 documentation + Installation — python-copier-template-example 0.5.4.dev7+ge96a449 documentation @@ -38,7 +38,7 @@ - +