1+ <!doctype html>
2+ < html class ="no-js " lang ="en " data-content_root ="./ ">
3+ < head > < meta charset ="utf-8 "/>
4+ < meta name ="viewport " content ="width=device-width,initial-scale=1 "/>
5+ < meta name ="color-scheme " content ="light dark "> < meta name ="viewport " content ="width=device-width, initial-scale=1 " />
6+ < link rel ="index " title ="Index " href ="genindex.html " /> < link rel ="search " title ="Search " href ="search.html " />
7+
8+ <!-- Generated with Sphinx 8.2.3 and Furo 2024.08.06 -->
9+ < title > .github - Python Project Templates v0.1.0</ title >
10+ < link rel ="stylesheet " type ="text/css " href ="_static/pygments.css?v=03e43079 " />
11+ < link rel ="stylesheet " type ="text/css " href ="_static/styles/furo.css?v=354aac6f " />
12+ < link rel ="stylesheet " type ="text/css " href ="_static/mystnb.8ecb98da25f57f5357bf6f572d296f466b2cfe2517ffebfabe82451661e28f02.css " />
13+ < link rel ="stylesheet " type ="text/css " href ="_static/copybutton.css?v=76b2166b " />
14+ < link rel ="stylesheet " type ="text/css " href ="_static/graphviz.css?v=4ae1632d " />
15+ < link rel ="stylesheet " type ="text/css " href ="_static/autodoc_pydantic.css " />
16+ < link rel ="stylesheet " type ="text/css " href ="_static/sphinx-design.min.css?v=95c83b7e " />
17+ < link rel ="stylesheet " type ="text/css " href ="_static/styles/furo-extensions.css?v=302659d7 " />
18+ < link rel ="stylesheet " type ="text/css " href ="_static/styles/custom.css?v=98e9b53e " />
19+
20+
21+
22+
23+ < style >
24+ body {
25+ --color-code-background : # eeffcc ;
26+ --color-code-foreground : black;
27+
28+ }
29+ @media not print {
30+ body [data-theme = "dark" ] {
31+ --color-code-background : # 202020 ;
32+ --color-code-foreground : # d0d0d0 ;
33+
34+ }
35+ @media (prefers-color-scheme : dark) {
36+ body : not ([data-theme = "light" ]) {
37+ --color-code-background : # 202020 ;
38+ --color-code-foreground : # d0d0d0 ;
39+
40+ }
41+ }
42+ }
43+ </ style > </ head >
44+ < body >
45+
46+ < script >
47+ document . body . dataset . theme = localStorage . getItem ( "theme" ) || "auto" ;
48+ </ script >
49+
50+
51+ < svg xmlns ="http://www.w3.org/2000/svg " style ="display: none; ">
52+ < symbol id ="svg-toc " viewBox ="0 0 24 24 ">
53+ < title > Contents</ title >
54+ < svg stroke ="currentColor " fill ="currentColor " stroke-width ="0 " viewBox ="0 0 1024 1024 ">
55+ < path d ="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z "/>
56+ </ svg >
57+ </ symbol >
58+ < symbol id ="svg-menu " viewBox ="0 0 24 24 ">
59+ < title > Menu</ title >
60+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
61+ stroke-width ="2 " stroke-linecap ="round " stroke-linejoin ="round " class ="feather-menu ">
62+ < line x1 ="3 " y1 ="12 " x2 ="21 " y2 ="12 "> </ line >
63+ < line x1 ="3 " y1 ="6 " x2 ="21 " y2 ="6 "> </ line >
64+ < line x1 ="3 " y1 ="18 " x2 ="21 " y2 ="18 "> </ line >
65+ </ svg >
66+ </ symbol >
67+ < symbol id ="svg-arrow-right " viewBox ="0 0 24 24 ">
68+ < title > Expand</ title >
69+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
70+ stroke-width ="2 " stroke-linecap ="round " stroke-linejoin ="round " class ="feather-chevron-right ">
71+ < polyline points ="9 18 15 12 9 6 "> </ polyline >
72+ </ svg >
73+ </ symbol >
74+ < symbol id ="svg-sun " viewBox ="0 0 24 24 ">
75+ < title > Light mode</ title >
76+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
77+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round " class ="feather-sun ">
78+ < circle cx ="12 " cy ="12 " r ="5 "> </ circle >
79+ < line x1 ="12 " y1 ="1 " x2 ="12 " y2 ="3 "> </ line >
80+ < line x1 ="12 " y1 ="21 " x2 ="12 " y2 ="23 "> </ line >
81+ < line x1 ="4.22 " y1 ="4.22 " x2 ="5.64 " y2 ="5.64 "> </ line >
82+ < line x1 ="18.36 " y1 ="18.36 " x2 ="19.78 " y2 ="19.78 "> </ line >
83+ < line x1 ="1 " y1 ="12 " x2 ="3 " y2 ="12 "> </ line >
84+ < line x1 ="21 " y1 ="12 " x2 ="23 " y2 ="12 "> </ line >
85+ < line x1 ="4.22 " y1 ="19.78 " x2 ="5.64 " y2 ="18.36 "> </ line >
86+ < line x1 ="18.36 " y1 ="5.64 " x2 ="19.78 " y2 ="4.22 "> </ line >
87+ </ svg >
88+ </ symbol >
89+ < symbol id ="svg-moon " viewBox ="0 0 24 24 ">
90+ < title > Dark mode</ title >
91+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
92+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round " class ="icon-tabler-moon ">
93+ < path stroke ="none " d ="M0 0h24v24H0z " fill ="none " />
94+ < path d ="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z " />
95+ </ svg >
96+ </ symbol >
97+ < symbol id ="svg-sun-with-moon " viewBox ="0 0 24 24 ">
98+ < title > Auto light/dark, in light mode</ title >
99+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
100+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round "
101+ class ="icon-custom-derived-from-feather-sun-and-tabler-moon ">
102+ < path style ="opacity: 50% " d ="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z "/>
103+ < line x1 ="14.5 " y1 ="3.25 " x2 ="14.5 " y2 ="1.25 "/>
104+ < line x1 ="14.5 " y1 ="15.85 " x2 ="14.5 " y2 ="17.85 "/>
105+ < line x1 ="10.044 " y1 ="5.094 " x2 ="8.63 " y2 ="3.68 "/>
106+ < line x1 ="19 " y1 ="14.05 " x2 ="20.414 " y2 ="15.464 "/>
107+ < line x1 ="8.2 " y1 ="9.55 " x2 ="6.2 " y2 ="9.55 "/>
108+ < line x1 ="20.8 " y1 ="9.55 " x2 ="22.8 " y2 ="9.55 "/>
109+ < line x1 ="10.044 " y1 ="14.006 " x2 ="8.63 " y2 ="15.42 "/>
110+ < line x1 ="19 " y1 ="5.05 " x2 ="20.414 " y2 ="3.636 "/>
111+ < circle cx ="14.5 " cy ="9.55 " r ="3.6 "/>
112+ </ svg >
113+ </ symbol >
114+ < symbol id ="svg-moon-with-sun " viewBox ="0 0 24 24 ">
115+ < title > Auto light/dark, in dark mode</ title >
116+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
117+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round "
118+ class ="icon-custom-derived-from-feather-sun-and-tabler-moon ">
119+ < path d ="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z "/>
120+ < line style ="opacity: 50% " x1 ="18 " y1 ="3.705 " x2 ="18 " y2 ="2.5 "/>
121+ < line style ="opacity: 50% " x1 ="18 " y1 ="11.295 " x2 ="18 " y2 ="12.5 "/>
122+ < line style ="opacity: 50% " x1 ="15.316 " y1 ="4.816 " x2 ="14.464 " y2 ="3.964 "/>
123+ < line style ="opacity: 50% " x1 ="20.711 " y1 ="10.212 " x2 ="21.563 " y2 ="11.063 "/>
124+ < line style ="opacity: 50% " x1 ="14.205 " y1 ="7.5 " x2 ="13.001 " y2 ="7.5 "/>
125+ < line style ="opacity: 50% " x1 ="21.795 " y1 ="7.5 " x2 ="23 " y2 ="7.5 "/>
126+ < line style ="opacity: 50% " x1 ="15.316 " y1 ="10.184 " x2 ="14.464 " y2 ="11.036 "/>
127+ < line style ="opacity: 50% " x1 ="20.711 " y1 ="4.789 " x2 ="21.563 " y2 ="3.937 "/>
128+ < circle style ="opacity: 50% " cx ="18 " cy ="7.5 " r ="2.169 "/>
129+ </ svg >
130+ </ symbol >
131+ < symbol id ="svg-pencil " viewBox ="0 0 24 24 ">
132+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
133+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round " class ="icon-tabler-pencil-code ">
134+ < path d ="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4 " />
135+ < path d ="M13.5 6.5l4 4 " />
136+ < path d ="M20 21l2 -2l-2 -2 " />
137+ < path d ="M17 17l-2 2l2 2 " />
138+ </ svg >
139+ </ symbol >
140+ < symbol id ="svg-eye " viewBox ="0 0 24 24 ">
141+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 " fill ="none " stroke ="currentColor "
142+ stroke-width ="1 " stroke-linecap ="round " stroke-linejoin ="round " class ="icon-tabler-eye-code ">
143+ < path stroke ="none " d ="M0 0h24v24H0z " fill ="none " />
144+ < path d ="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0 " />
145+ < path
146+ d ="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008 " />
147+ < path d ="M20 21l2 -2l-2 -2 " />
148+ < path d ="M17 17l-2 2l2 2 " />
149+ </ svg >
150+ </ symbol >
151+ </ svg >
152+
153+ < input type ="checkbox " class ="sidebar-toggle " name ="__navigation " id ="__navigation ">
154+ < input type ="checkbox " class ="sidebar-toggle " name ="__toc " id ="__toc ">
155+ < label class ="overlay sidebar-overlay " for ="__navigation ">
156+ < div class ="visually-hidden "> Hide navigation sidebar</ div >
157+ </ label >
158+ < label class ="overlay toc-overlay " for ="__toc ">
159+ < div class ="visually-hidden "> Hide table of contents sidebar</ div >
160+ </ label >
161+
162+ < a class ="skip-to-content muted-link " href ="#furo-main-content "> Skip to content</ a >
163+
164+
165+
166+ < div class ="page ">
167+ < header class ="mobile-header ">
168+ < div class ="header-left ">
169+ < label class ="nav-overlay-icon " for ="__navigation ">
170+ < div class ="visually-hidden "> Toggle site navigation sidebar</ div >
171+ < i class ="icon "> < svg > < use href ="#svg-menu "> </ use > </ svg > </ i >
172+ </ label >
173+ </ div >
174+ < div class ="header-center ">
175+ < a href ="index.html "> < div class ="brand "> Python Project Templates < code style ='font-size: var(--font-size--small--4);color: var(--sd-color-primary); '> v0.1.0</ code > </ div > </ a >
176+ </ div >
177+ < div class ="header-right ">
178+ < div class ="theme-toggle-container theme-toggle-header ">
179+ < button class ="theme-toggle ">
180+ < div class ="visually-hidden "> Toggle Light / Dark / Auto color theme</ div >
181+ < svg class ="theme-icon-when-auto-light "> < use href ="#svg-sun-with-moon "> </ use > </ svg >
182+ < svg class ="theme-icon-when-auto-dark "> < use href ="#svg-moon-with-sun "> </ use > </ svg >
183+ < svg class ="theme-icon-when-dark "> < use href ="#svg-moon "> </ use > </ svg >
184+ < svg class ="theme-icon-when-light "> < use href ="#svg-sun "> </ use > </ svg >
185+ </ button >
186+ </ div >
187+ < label class ="toc-overlay-icon toc-header-icon no-toc " for ="__toc ">
188+ < div class ="visually-hidden "> Toggle table of contents sidebar</ div >
189+ < i class ="icon "> < svg > < use href ="#svg-toc "> </ use > </ svg > </ i >
190+ </ label >
191+ </ div >
192+ </ header >
193+ < aside class ="sidebar-drawer ">
194+ < div class ="sidebar-container ">
195+
196+ < div class ="sidebar-sticky "> < a class ="sidebar-brand " href ="index.html ">
197+
198+
199+ < span class ="sidebar-brand-text "> Python Project Templates < code style ='font-size: var(--font-size--small--4);color: var(--sd-color-primary); '> v0.1.0</ code > </ span >
200+
201+ </ a > < form class ="sidebar-search-container " method ="get " action ="search.html " role ="search ">
202+ < input class ="sidebar-search " placeholder ="Search " name ="q " aria-label ="Search ">
203+ < input type ="hidden " name ="check_keywords " value ="yes ">
204+ < input type ="hidden " name ="area " value ="default ">
205+ </ form >
206+ < div id ="searchbox "> </ div > < div class ="sidebar-scroll "> < div class ="sidebar-tree ">
207+
208+ </ div >
209+ </ div >
210+
211+ </ div >
212+
213+ </ div >
214+ </ aside >
215+ < div class ="main ">
216+ < div class ="content ">
217+ < div class ="article-container ">
218+ < a href ="# " class ="back-to-top muted-link ">
219+ < svg xmlns ="http://www.w3.org/2000/svg " viewBox ="0 0 24 24 ">
220+ < path d ="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z "> </ path >
221+ </ svg >
222+ < span > Back to top</ span >
223+ </ a >
224+ < div class ="content-icon-container ">
225+ < div class ="view-this-page ">
226+ < a class ="muted-link " href ="_sources/README.md.txt " title ="View this page ">
227+ < svg > < use href ="#svg-eye "> </ use > </ svg >
228+ < span class ="visually-hidden "> View this page</ span >
229+ </ a >
230+ </ div >
231+ < div class ="theme-toggle-container theme-toggle-content ">
232+ < button class ="theme-toggle ">
233+ < div class ="visually-hidden "> Toggle Light / Dark / Auto color theme</ div >
234+ < svg class ="theme-icon-when-auto-light "> < use href ="#svg-sun-with-moon "> </ use > </ svg >
235+ < svg class ="theme-icon-when-auto-dark "> < use href ="#svg-moon-with-sun "> </ use > </ svg >
236+ < svg class ="theme-icon-when-dark "> < use href ="#svg-moon "> </ use > </ svg >
237+ < svg class ="theme-icon-when-light "> < use href ="#svg-sun "> </ use > </ svg >
238+ </ button >
239+ </ div >
240+ < label class ="toc-overlay-icon toc-content-icon no-toc " for ="__toc ">
241+ < div class ="visually-hidden "> Toggle table of contents sidebar</ div >
242+ < i class ="icon "> < svg > < use href ="#svg-toc "> </ use > </ svg > </ i >
243+ </ label >
244+ </ div >
245+ < article role ="main " id ="furo-main-content ">
246+ < section class ="tex2jax_ignore mathjax_ignore " id ="github ">
247+ < h1 > .github< a class ="headerlink " href ="#github " title ="Link to this heading "> ¶</ a > </ h1 >
248+ </ section >
249+
250+ </ article >
251+ </ div >
252+ < footer >
253+
254+ < div class ="related-pages ">
255+
256+
257+ </ div >
258+ < div class ="bottom-of-page ">
259+ < div class ="left-details ">
260+ < div class ="copyright ">
261+ Copyright © the python-project-template authors
262+ </ div >
263+ Made with < a href ="https://www.sphinx-doc.org/ "> Sphinx</ a > and < a class ="muted-link " href ="https://pradyunsg.me "> @pradyunsg</ a > 's
264+
265+ < a href ="https://github.com/pradyunsg/furo "> Furo</ a >
266+
267+ </ div >
268+ < div class ="right-details ">
269+
270+ </ div >
271+ </ div >
272+
273+ </ footer >
274+ </ div >
275+ < aside class ="toc-drawer no-toc ">
276+
277+
278+
279+ </ aside >
280+ </ div >
281+ </ div > < script src ="_static/documentation_options.js?v=01f34227 "> </ script >
282+ < script src ="_static/doctools.js?v=9bcbadda "> </ script >
283+ < script src ="_static/sphinx_highlight.js?v=dc90522c "> </ script >
284+ < script src ="_static/scripts/furo.js?v=5fa4622c "> </ script >
285+ < script src ="_static/clipboard.min.js?v=a7894cd8 "> </ script >
286+ < script src ="_static/copybutton.js?v=f281be69 "> </ script >
287+ < script src ="_static/design-tabs.js?v=f930bc37 "> </ script >
288+ < script src ="_static/js/custom.js?v=956e5d78 "> </ script >
289+ </ body >
290+ </ html >
0 commit comments