Skip to content

Commit e3c7db4

Browse files
KDesp73KDesp73
committed
feat: removed site generation, loading docs with js
1 parent a8135da commit e3c7db4

11 files changed

Lines changed: 307 additions & 1359 deletions

File tree

‎docs/index.html‎

Lines changed: 138 additions & 928 deletions
Large diffs are not rendered by default.

‎docs/tiny.docs.json‎

Lines changed: 34 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,7 @@
11
{
22
"name": "tinydocs",
3-
"timestamp": "2026-03-03 13:42:08",
3+
"timestamp": "2026-03-03 21:46:22",
44
"docs": [
5-
{
6-
"file": "tinydocs/generator.py",
7-
"docs": {
8-
"marker": "module",
9-
"type": "module",
10-
"args": [
11-
"generator"
12-
],
13-
"line": 1,
14-
"children": [
15-
{
16-
"marker": "class",
17-
"type": "class",
18-
"args": [
19-
"SiteGenerator"
20-
],
21-
"line": 6,
22-
"children": [
23-
{
24-
"marker": "desc",
25-
"type": "description",
26-
"args": [
27-
"Converts the TinyDocs JSON output into a searchable HTML static site."
28-
],
29-
"line": 7,
30-
"children": []
31-
},
32-
{
33-
"marker": "example",
34-
"type": "example",
35-
"args": [
36-
"gen = SiteGenerator(\"tiny.docs.json\")\ngen.generate()"
37-
],
38-
"line": 9,
39-
"children": []
40-
}
41-
]
42-
},
43-
{
44-
"marker": "method",
45-
"type": "function",
46-
"args": [
47-
"generate"
48-
],
49-
"line": 17,
50-
"children": [
51-
{
52-
"marker": "desc",
53-
"type": "description",
54-
"args": [
55-
"Reads the JSON file and renders the Jinja2 template."
56-
],
57-
"line": 18,
58-
"children": []
59-
}
60-
]
61-
}
62-
]
63-
}
64-
},
655
{
666
"file": "tinydocs/ignore.py",
677
"docs": {
@@ -198,7 +138,8 @@
198138
"marker": "returns",
199139
"type": "return",
200140
"args": [
201-
"bool True if the path should be ignored."
141+
"bool",
142+
"True if the path should be ignored."
202143
],
203144
"line": 58,
204145
"children": []
@@ -236,7 +177,8 @@
236177
"marker": "returns",
237178
"type": "return",
238179
"args": [
239-
"List[str] A sorted list of non-ignored file paths."
180+
"List[str]",
181+
"A sorted list of non-ignored file paths."
240182
],
241183
"line": 100,
242184
"children": []
@@ -300,15 +242,15 @@
300242
"args": [
301243
"Marker"
302244
],
303-
"line": 31,
245+
"line": 30,
304246
"children": [
305247
{
306248
"marker": "desc",
307249
"type": "description",
308250
"args": [
309251
"Represents a documentation tag configuration, defining how to identify and split arguments for specific markers."
310252
],
311-
"line": 32,
253+
"line": 31,
312254
"children": []
313255
}
314256
]
@@ -317,7 +259,7 @@
317259
"marker": "constructor",
318260
"type": "function",
319261
"args": [],
320-
"line": 35,
262+
"line": 34,
321263
"children": [
322264
{
323265
"marker": "param",
@@ -326,7 +268,7 @@
326268
"name",
327269
"The name of the marker (e.g., 'param', 'method')"
328270
],
329-
"line": 36,
271+
"line": 35,
330272
"children": []
331273
},
332274
{
@@ -336,7 +278,7 @@
336278
"arg",
337279
"Whether the marker requires an argument"
338280
],
339-
"line": 37,
281+
"line": 36,
340282
"children": []
341283
},
342284
{
@@ -346,7 +288,7 @@
346288
"argc",
347289
"The number of expected arguments for splitting"
348290
],
349-
"line": 38,
291+
"line": 37,
350292
"children": []
351293
},
352294
{
@@ -356,7 +298,7 @@
356298
"prefix",
357299
"The symbol prefix, usually '@'"
358300
],
359-
"line": 39,
301+
"line": 38,
360302
"children": []
361303
}
362304
]
@@ -367,24 +309,25 @@
367309
"args": [
368310
"pattern"
369311
],
370-
"line": 54,
312+
"line": 53,
371313
"children": [
372314
{
373315
"marker": "desc",
374316
"type": "description",
375317
"args": [
376318
"Generates a regex pattern to match the marker in a string"
377319
],
378-
"line": 55,
320+
"line": 54,
379321
"children": []
380322
},
381323
{
382324
"marker": "returns",
383325
"type": "return",
384326
"args": [
385-
"str The compiled regex pattern"
327+
"str",
328+
"The compiled regex pattern"
386329
],
387-
"line": 56,
330+
"line": 55,
388331
"children": []
389332
}
390333
]
@@ -395,24 +338,25 @@
395338
"args": [
396339
"to_dict"
397340
],
398-
"line": 68,
341+
"line": 67,
399342
"children": [
400343
{
401344
"marker": "desc",
402345
"type": "description",
403346
"args": [
404347
"Serializes the marker instance into a dictionary"
405348
],
406-
"line": 69,
349+
"line": 68,
407350
"children": []
408351
},
409352
{
410353
"marker": "returns",
411354
"type": "return",
412355
"args": [
413-
"Dict[str, Any]"
356+
"Dict[str,",
357+
"Any]"
414358
],
415-
"line": 70,
359+
"line": 69,
416360
"children": []
417361
}
418362
]
@@ -423,7 +367,7 @@
423367
"args": [
424368
"from_dict"
425369
],
426-
"line": 80,
370+
"line": 79,
427371
"children": [
428372
{
429373
"marker": "param",
@@ -432,16 +376,17 @@
432376
"d",
433377
"The dictionary containing marker data"
434378
],
435-
"line": 81,
379+
"line": 80,
436380
"children": []
437381
},
438382
{
439383
"marker": "returns",
440384
"type": "return",
441385
"args": [
442-
"Marker A new instance of Marker"
386+
"Marker",
387+
"A new instance of Marker"
443388
],
444-
"line": 82,
389+
"line": 81,
445390
"children": []
446391
}
447392
]
@@ -452,7 +397,7 @@
452397
"args": [
453398
"parse"
454399
],
455-
"line": 96,
400+
"line": 95,
456401
"children": [
457402
{
458403
"marker": "param",
@@ -461,16 +406,17 @@
461406
"json_str",
462407
"A JSON string representing a list of markers"
463408
],
464-
"line": 97,
409+
"line": 96,
465410
"children": []
466411
},
467412
{
468413
"marker": "returns",
469414
"type": "return",
470415
"args": [
471-
"List[Marker] A list of parsed Marker instances"
416+
"List[Marker]",
417+
"A list of parsed Marker instances"
472418
],
473-
"line": 98,
419+
"line": 97,
474420
"children": []
475421
}
476422
]
@@ -557,7 +503,8 @@
557503
"marker": "returns",
558504
"type": "return",
559505
"args": [
560-
"List[Dict[str, Any]]"
506+
"List[Dict[str,",
507+
"Any]]"
561508
],
562509
"line": 27,
563510
"children": []

0 commit comments

Comments
 (0)