Time tracking you can host anywhere, built on Django. Full export support in multiple formats and easily extensible.
djangodockerhandcodedpythonself-hostedtime-trackingtimetracker
1
2
3
4<!doctype html>
5<html lang="en" class="no-js">
6 <head>
7
8 <meta charset="utf-8">
9 <meta name="viewport" content="width=device-width,initial-scale=1">
10
11 <meta name="description" content="Docs for the Timestrap project.">
12
13
14 <link rel="canonical" href="https://timestrap.bythewood.me/docs/">
15
16
17 <meta name="author" content="Isaac Bythewood">
18
19 <link rel="shortcut icon" href="../assets/images/favicon.png">
20 <meta name="generator" content="mkdocs-1.2.4, mkdocs-material-5.4.0">
21
22
23
24 <title>Docs - Timestrap Docs</title>
25
26
27
28 <link rel="stylesheet" href="../assets/stylesheets/main.fe0cca5b.min.css">
29
30 <link rel="stylesheet" href="../assets/stylesheets/palette.a46bcfb3.min.css">
31
32
33
34
35 <meta name="theme-color" content="#3f51b5">
36
37
38
39
40
41 <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
42 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback">
43 <style>body,input{font-family:"Roboto",-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono",SFMono-Regular,Consolas,Menlo,monospace}</style>
44
45
46
47
48
49
50
51
52 </head>
53
54
55
56
57
58 <body dir="ltr" data-md-color-scheme="" data-md-color-primary="indigo" data-md-color-accent="indigo">
59
60
61 <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
62 <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
63 <label class="md-overlay" for="__drawer"></label>
64 <div data-md-component="skip">
65
66
67 <a href="#docs" class="md-skip">
68 Skip to content
69 </a>
70
71 </div>
72 <div data-md-component="announce">
73
74 </div>
75
76 <header class="md-header" data-md-component="header">
77 <nav class="md-header-nav md-grid" aria-label="Header">
78 <a href="https://timestrap.bythewood.me/" title="Timestrap Docs" class="md-header-nav__button md-logo" aria-label="Timestrap Docs">
79
80
81 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
82
83 </a>
84 <label class="md-header-nav__button md-icon" for="__drawer">
85 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg>
86 </label>
87 <div class="md-header-nav__title" data-md-component="header-title">
88
89 <div class="md-header-nav__ellipsis">
90 <span class="md-header-nav__topic md-ellipsis">
91 Timestrap Docs
92 </span>
93 <span class="md-header-nav__topic md-ellipsis">
94
95 Docs
96
97 </span>
98 </div>
99
100 </div>
101
102 <label class="md-header-nav__button md-icon" for="__search">
103 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
104 </label>
105
106<div class="md-search" data-md-component="search" role="dialog">
107 <label class="md-search__overlay" for="__search"></label>
108 <div class="md-search__inner" role="search">
109 <form class="md-search__form" name="search">
110 <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" data-md-state="active">
111 <label class="md-search__icon md-icon" for="__search">
112 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0116 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 019.5 16 6.5 6.5 0 013 9.5 6.5 6.5 0 019.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg>
113 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
114 </label>
115 <button type="reset" class="md-search__icon md-icon" aria-label="Clear" data-md-component="search-reset" tabindex="-1">
116 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41L17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg>
117 </button>
118 </form>
119 <div class="md-search__output">
120 <div class="md-search__scrollwrap" data-md-scrollfix>
121 <div class="md-search-result" data-md-component="search-result">
122 <div class="md-search-result__meta">
123 Initializing search
124 </div>
125 <ol class="md-search-result__list"></ol>
126 </div>
127 </div>
128 </div>
129 </div>
130</div>
131
132
133 <div class="md-header-nav__source">
134
135<a href="https://github.com/overshard/timestrap/" title="Go to repository" class="md-source">
136 <div class="md-source__icon md-icon">
137
138 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
139 </div>
140 <div class="md-source__repository">
141 overshard/timestrap
142 </div>
143</a>
144 </div>
145
146 </nav>
147</header>
148
149 <div class="md-container" data-md-component="container">
150
151
152
153
154
155
156 <main class="md-main" data-md-component="main">
157 <div class="md-main__inner md-grid">
158
159
160 <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
161 <div class="md-sidebar__scrollwrap">
162 <div class="md-sidebar__inner">
163 <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
164 <label class="md-nav__title" for="__drawer">
165 <a href="https://timestrap.bythewood.me/" title="Timestrap Docs" class="md-nav__button md-logo" aria-label="Timestrap Docs">
166
167
168 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 003-3 3 3 0 00-3-3 3 3 0 00-3 3 3 3 0 003 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54z"/></svg>
169
170 </a>
171 Timestrap Docs
172 </label>
173
174 <div class="md-nav__source">
175
176<a href="https://github.com/overshard/timestrap/" title="Go to repository" class="md-source">
177 <div class="md-source__icon md-icon">
178
179 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05L244 40.45a28.87 28.87 0 00-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 01-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 000 40.81l195.61 195.6a28.86 28.86 0 0040.8 0l194.69-194.69a28.86 28.86 0 000-40.81z"/></svg>
180 </div>
181 <div class="md-source__repository">
182 overshard/timestrap
183 </div>
184</a>
185 </div>
186
187 <ul class="md-nav__list" data-md-scrollfix>
188
189
190
191
192
193
194 <li class="md-nav__item">
195 <a href=".." title="Home" class="md-nav__link">
196 Home
197 </a>
198 </li>
199
200
201
202
203
204
205
206 <li class="md-nav__item">
207 <a href="../screenshots/" title="Screenshots" class="md-nav__link">
208 Screenshots
209 </a>
210 </li>
211
212
213
214
215
216
217
218 <li class="md-nav__item">
219 <a href="../configuration/" title="Configuration" class="md-nav__link">
220 Configuration
221 </a>
222 </li>
223
224
225
226
227
228
229
230 <li class="md-nav__item">
231 <a href="../permissions/" title="Permissions" class="md-nav__link">
232 Permissions
233 </a>
234 </li>
235
236
237
238
239
240
241
242 <li class="md-nav__item">
243 <a href="../sites/" title="Sites" class="md-nav__link">
244 Sites
245 </a>
246 </li>
247
248
249
250
251
252
253
254 <li class="md-nav__item">
255 <a href="../uses/" title="Uses" class="md-nav__link">
256 Uses
257 </a>
258 </li>
259
260
261
262
263
264
265
266
267
268 <li class="md-nav__item md-nav__item--active">
269
270 <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
271
272
273
274
275 <a href="./" title="Docs" class="md-nav__link md-nav__link--active">
276 Docs
277 </a>
278
279 </li>
280
281
282
283
284
285
286
287 <li class="md-nav__item">
288 <a href="../contributing/" title="Contributing" class="md-nav__link">
289 Contributing
290 </a>
291 </li>
292
293
294
295
296
297
298
299 <li class="md-nav__item">
300 <a href="../license/" title="License" class="md-nav__link">
301 License
302 </a>
303 </li>
304
305
306 </ul>
307</nav>
308 </div>
309 </div>
310 </div>
311
312
313 <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
314 <div class="md-sidebar__scrollwrap">
315 <div class="md-sidebar__inner">
316
317<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
318
319
320
321
322
323</nav>
324 </div>
325 </div>
326 </div>
327
328
329 <div class="md-content">
330 <article class="md-content__inner md-typeset">
331
332
333 <a href="https://github.com/overshard/timestrap/edit/master/docs/src/docs.md" title="Edit this page" class="md-content__button md-icon">
334 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>
335 </a>
336
337
338
339
340
341 <h1 id="docs">Docs<a class="headerlink" href="#docs" title="Permanent link">¶</a></h1>
342<p>Timestrap's docs are built with <code>mkdocs</code>. If you have dev dependencies
343installed, <code>pipenv install --dev</code>, then you can use the following commands:</p>
344<ul>
345<li><code>gulp docs:serve</code> for testing</li>
346<li><code>gulp docs:build</code> to build the files</li>
347<li><code>gulp docs:publish</code> to publish to github</li>
348</ul>
349
350
351
352
353
354
355
356 </article>
357 </div>
358 </div>
359 </main>
360
361
362<footer class="md-footer">
363
364 <div class="md-footer-nav">
365 <nav class="md-footer-nav__inner md-grid" aria-label="Footer">
366
367 <a href="../uses/" title="Uses" class="md-footer-nav__link md-footer-nav__link--prev" rel="prev">
368 <div class="md-footer-nav__button md-icon">
369 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg>
370 </div>
371 <div class="md-footer-nav__title">
372 <div class="md-ellipsis">
373 <span class="md-footer-nav__direction">
374 Previous
375 </span>
376 Uses
377 </div>
378 </div>
379 </a>
380
381
382 <a href="../contributing/" title="Contributing" class="md-footer-nav__link md-footer-nav__link--next" rel="next">
383 <div class="md-footer-nav__title">
384 <div class="md-ellipsis">
385 <span class="md-footer-nav__direction">
386 Next
387 </span>
388 Contributing
389 </div>
390 </div>
391 <div class="md-footer-nav__button md-icon">
392 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4z"/></svg>
393 </div>
394 </a>
395
396 </nav>
397 </div>
398
399 <div class="md-footer-meta md-typeset">
400 <div class="md-footer-meta__inner md-grid">
401 <div class="md-footer-copyright">
402
403 <div class="md-footer-copyright__highlight">
404 Copyright © 2019 Isaac Bythewood
405 </div>
406
407 Made with
408 <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
409 Material for MkDocs
410 </a>
411 </div>
412
413 </div>
414 </div>
415</footer>
416
417 </div>
418
419 <script src="../assets/javascripts/vendor.d710d30a.min.js"></script>
420 <script src="../assets/javascripts/bundle.b39636ac.min.js"></script><script id="__lang" type="application/json">{"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents"}</script>
421
422 <script>
423 app = initialize({
424 base: "..",
425 features: [],
426 search: Object.assign({
427 worker: "../assets/javascripts/worker/search.a68abb33.min.js"
428 }, typeof search !== "undefined" && search)
429 })
430 </script>
431
432
433 </body>
434</html>