Skip to content

Commit 54165ce

Browse files
KDesp73KDesp73
committed
feat: removed MarkerType
1 parent 6354510 commit 54165ce

5 files changed

Lines changed: 31 additions & 117 deletions

File tree

‎docs/index.html‎

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<div class="max-w-7xl mx-auto px-4 py-4 flex flex-col md:flex-row md:items-center justify-between gap-4">
3434
<div>
3535
<h1 class="text-2xl font-bold text-indigo-600">tinydocs</h1>
36-
<p class="text-xs text-gray-500 uppercase tracking-widest">Generated on 2026-03-02 21:37:26 by tinydocs</p>
36+
<p class="text-xs text-gray-500 uppercase tracking-widest">Generated on 2026-03-02 22:28:59 by tinydocs</p>
3737
</div>
3838
<div class="relative w-full md:w-96">
3939
<input type="text" x-model="search" placeholder="Search modules, classes, or methods..."
@@ -350,10 +350,6 @@ <h3 class="font-bold text-gray-800 text-lg" :class="search && 'filter that are n
350350

351351

352352

353-
354-
355-
356-
357353

358354

359355

@@ -376,7 +372,7 @@ <h3 class="font-bold text-gray-800 text-lg" :class="search && 'filter that are n
376372

377373

378374
<section class="bg-white rounded-xl shadow-sm border border-gray-200 overflow-hidden transition-all"
379-
x-show="shouldShowModule('tinydocs/markers.py', 'markers', ["MarkerType", "Argument", "Marker to identify and split arguments for specific markers.", "pattern", "to_dict", "from_dict", "parse"])"
375+
x-show="shouldShowModule('tinydocs/markers.py', 'markers', ["Argument", "Marker to identify and split arguments for specific markers.", "pattern", "to_dict", "from_dict", "parse"])"
380376
x-cloak>
381377

382378
<div class="bg-gray-800 text-white px-6 py-3 flex justify-between items-center">
@@ -394,25 +390,6 @@ <h2 class="font-mono text-sm" :class="search && 'tinydocs/markers.py'.toLowerCas
394390

395391
<div class="space-y-6">
396392

397-
<div class="border-l-4 border-indigo-200 pl-4 py-1 transition-all"
398-
x-show="shouldShowChild('MarkerType', 'markers')">
399-
400-
<div class="flex items-center gap-2 mb-1">
401-
<span class="text-[10px] font-bold px-1.5 py-0.5 rounded bg-gray-100 border border-gray-300 text-gray-600 uppercase">enum</span>
402-
<h3 class="font-bold text-gray-800 text-lg" :class="search && 'MarkerType'.toLowerCase().includes(search.toLowerCase()) ? 'bg-yellow-200' : ''">
403-
MarkerType
404-
</h3>
405-
</div>
406-
407-
<div class="ml-4 space-y-2 mt-2">
408-
409-
410-
<p class="text-gray-600 italic text-sm">Defines the various marker types</p>
411-
412-
413-
</div>
414-
</div>
415-
416393
<div class="border-l-4 border-indigo-200 pl-4 py-1 transition-all"
417394
x-show="shouldShowChild('Argument', 'markers')">
418395

@@ -471,13 +448,6 @@ <h3 class="font-bold text-gray-800 text-lg" :class="search && ''.toLowerCase().i
471448

472449

473450

474-
<div class="text-sm flex items-start gap-2">
475-
<code class="text-pink-600 font-bold px-1 bg-pink-50 rounded">type</code>
476-
<span class="text-gray-500">The category of the marker from MarkerType</span>
477-
</div>
478-
479-
480-
481451
<div class="text-sm flex items-start gap-2">
482452
<code class="text-pink-600 font-bold px-1 bg-pink-50 rounded">arg</code>
483453
<span class="text-gray-500">Whether the marker requires an argument</span>
@@ -744,4 +714,4 @@ <h3 class="font-bold text-gray-800 text-lg" :class="search && 'parse'.toLowerCas
744714
</main>
745715

746716
</body>
747-
</html>
717+
</html>

‎docs/tiny.docs.json‎

Lines changed: 23 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "tinydocs",
3-
"timestamp": "2026-03-02 21:37:26",
3+
"timestamp": "2026-03-02 22:28:59",
44
"docs": [
55
{
66
"file": "tinydocs/generator.py",
@@ -222,36 +222,19 @@
222222
],
223223
"line": 1,
224224
"children": [
225-
{
226-
"marker": "enum",
227-
"args": [
228-
"MarkerType"
229-
],
230-
"line": 8,
231-
"children": [
232-
{
233-
"marker": "desc",
234-
"args": [
235-
"Defines the various marker types"
236-
],
237-
"line": 9,
238-
"children": []
239-
}
240-
]
241-
},
242225
{
243226
"marker": "enum",
244227
"args": [
245228
"Argument"
246229
],
247-
"line": 24,
230+
"line": 8,
248231
"children": [
249232
{
250233
"marker": "desc",
251234
"args": [
252235
"Defines the argument necessity states"
253236
],
254-
"line": 25,
237+
"line": 9,
255238
"children": []
256239
}
257240
]
@@ -261,39 +244,30 @@
261244
"args": [
262245
"Marker to identify and split arguments for specific markers."
263246
],
264-
"line": 31,
247+
"line": 15,
265248
"children": [
266249
{
267250
"marker": "desc",
268251
"args": [
269252
"Represents a documentation tag configuration, defining how"
270253
],
271-
"line": 32,
254+
"line": 16,
272255
"children": []
273256
}
274257
]
275258
},
276259
{
277260
"marker": "constructor",
278261
"args": [],
279-
"line": 35,
262+
"line": 19,
280263
"children": [
281264
{
282265
"marker": "param",
283266
"args": [
284267
"name",
285268
"The name of the marker (e.g., 'param', 'method')"
286269
],
287-
"line": 36,
288-
"children": []
289-
},
290-
{
291-
"marker": "param",
292-
"args": [
293-
"type",
294-
"The category of the marker from MarkerType"
295-
],
296-
"line": 37,
270+
"line": 20,
297271
"children": []
298272
},
299273
{
@@ -302,7 +276,7 @@
302276
"arg",
303277
"Whether the marker requires an argument"
304278
],
305-
"line": 38,
279+
"line": 21,
306280
"children": []
307281
},
308282
{
@@ -311,7 +285,7 @@
311285
"argc",
312286
"The number of expected arguments for splitting"
313287
],
314-
"line": 39,
288+
"line": 22,
315289
"children": []
316290
},
317291
{
@@ -320,7 +294,7 @@
320294
"prefix",
321295
"The symbol prefix, usually '@'"
322296
],
323-
"line": 40,
297+
"line": 23,
324298
"children": []
325299
}
326300
]
@@ -330,22 +304,22 @@
330304
"args": [
331305
"pattern"
332306
],
333-
"line": 55,
307+
"line": 36,
334308
"children": [
335309
{
336310
"marker": "desc",
337311
"args": [
338312
"Generates a regex pattern to match the marker in a string"
339313
],
340-
"line": 56,
314+
"line": 37,
341315
"children": []
342316
},
343317
{
344318
"marker": "returns",
345319
"args": [
346320
"str The compiled regex pattern"
347321
],
348-
"line": 57,
322+
"line": 38,
349323
"children": []
350324
}
351325
]
@@ -355,22 +329,22 @@
355329
"args": [
356330
"to_dict"
357331
],
358-
"line": 69,
332+
"line": 50,
359333
"children": [
360334
{
361335
"marker": "desc",
362336
"args": [
363337
"Serializes the marker instance into a dictionary"
364338
],
365-
"line": 70,
339+
"line": 51,
366340
"children": []
367341
},
368342
{
369343
"marker": "returns",
370344
"args": [
371345
"Dict[str, Any]"
372346
],
373-
"line": 71,
347+
"line": 52,
374348
"children": []
375349
}
376350
]
@@ -380,23 +354,23 @@
380354
"args": [
381355
"from_dict"
382356
],
383-
"line": 81,
357+
"line": 61,
384358
"children": [
385359
{
386360
"marker": "param",
387361
"args": [
388362
"d",
389363
"The dictionary containing marker data"
390364
],
391-
"line": 82,
365+
"line": 62,
392366
"children": []
393367
},
394368
{
395369
"marker": "returns",
396370
"args": [
397371
"Marker A new instance of Marker"
398372
],
399-
"line": 83,
373+
"line": 63,
400374
"children": []
401375
}
402376
]
@@ -406,23 +380,23 @@
406380
"args": [
407381
"parse"
408382
],
409-
"line": 97,
383+
"line": 75,
410384
"children": [
411385
{
412386
"marker": "param",
413387
"args": [
414388
"json_str",
415389
"A JSON string representing a list of markers"
416390
],
417-
"line": 98,
391+
"line": 76,
418392
"children": []
419393
},
420394
{
421395
"marker": "returns",
422396
"args": [
423397
"List[Marker] A list of parsed Marker instances"
424398
],
425-
"line": 99,
399+
"line": 77,
426400
"children": []
427401
}
428402
]
@@ -511,4 +485,4 @@
511485
}
512486
}
513487
]
514-
}
488+
}

‎docs/tiny.markers.json‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,56 +2,48 @@
22
{
33
"prefix": "@",
44
"name": "module",
5-
"type": "module",
65
"arg": "required",
76
"argc": 1
87
},
98
{
109
"prefix": "@",
1110
"name": "class",
12-
"type": "class",
1311
"arg": "required",
1412
"argc": 1
1513
},
1614
{
1715
"prefix": "@",
1816
"name": "enum",
19-
"type": "class",
2017
"arg": "required",
2118
"argc": 1
2219
},
2320
{
2421
"prefix": "@",
2522
"name": "method",
26-
"type": "function",
2723
"arg": "required",
2824
"argc": 1
2925
},
3026
{
3127
"prefix": "@",
3228
"name": "desc",
33-
"type": "description",
3429
"arg": "required",
3530
"argc": 1
3631
},
3732
{
3833
"prefix": "@",
3934
"name": "param",
40-
"type": "parameter",
4135
"arg": "required",
4236
"argc": 2
4337
},
4438
{
4539
"prefix": "@",
4640
"name": "constructor",
47-
"type": "any",
4841
"arg": "none",
4942
"argc": 1
5043
},
5144
{
5245
"prefix": "@",
5346
"name": "returns",
54-
"type": "return",
5547
"arg": "required",
5648
"argc": 1
5749
}

‎tinydocs/__init__.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
from .ignore import IgnoreChecker
2-
from .markers import Marker, MarkerType, Argument
2+
from .markers import Marker, Argument
33
from .generator import SiteGenerator
44
from .parser import Parser
55

6-
__version__ = "0.1.0"
6+
__version__ = "0.1.1"
77

88
__all__ = [
99
"IgnoreChecker",
1010
"Marker",
11-
"MarkerType",
11+
"SiteGenerator",
1212
"Argument",
1313
"Parser"
1414
]

0 commit comments

Comments
 (0)