Skip to content

Commit 82eeb74

Browse files
committed
docs: added author and license
1 parent 5d0cba1 commit 82eeb74

6 files changed

Lines changed: 57 additions & 10 deletions

File tree

docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
async init() {
3030
try {
31-
const response = await fetch('tiny.docs.json');
31+
const response = await fetch('/tiny.docs.json');
3232
this.projectData = await response.json();
3333
} catch (e) {
3434
console.error("Failed to load documentation JSON", e);
@@ -86,7 +86,7 @@ <h1 class="text-xl font-black text-slate-800 dark:text-white tracking-tight" x-t
8686
</div>
8787
</header>
8888

89-
<main class="max-w-7xl mx-auto px-6 pt-4 pb-12">
89+
<main class="max-w-7xl mx-auto px-6 pb-12">
9090
<div class="space-y-12">
9191
<template x-for="item in projectData.docs" :key="item.file">
9292
<section x-show="shouldShowModule(item)" x-cloak class="relative">

docs/tiny.docs.json

Lines changed: 37 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,38 @@
11
{
22
"name": "tinydocs",
3-
"timestamp": "2026-03-03 22:09:56",
3+
"timestamp": "2026-03-03 22:25:08",
44
"docs": [
5+
{
6+
"file": "tinydocs/__init__.py",
7+
"docs": {
8+
"marker": "module",
9+
"type": "module",
10+
"args": [
11+
"tinydocs"
12+
],
13+
"line": 5,
14+
"children": [
15+
{
16+
"marker": "author",
17+
"type": "author",
18+
"args": [
19+
"Konstantinos Despoinidis (KDesp73)"
20+
],
21+
"line": 6,
22+
"children": []
23+
},
24+
{
25+
"marker": "license",
26+
"type": "license",
27+
"args": [
28+
"MIT"
29+
],
30+
"line": 7,
31+
"children": []
32+
}
33+
]
34+
}
35+
},
536
{
637
"file": "tinydocs/ignore.py",
738
"docs": {
@@ -353,8 +384,8 @@
353384
"marker": "returns",
354385
"type": "return",
355386
"args": [
356-
"Dict[str,",
357-
"Any]"
387+
"Dict[str,Any]",
388+
"Marker as a dictionary"
358389
],
359390
"line": 69,
360391
"children": []
@@ -503,8 +534,8 @@
503534
"marker": "returns",
504535
"type": "return",
505536
"args": [
506-
"List[Dict[str,",
507-
"Any]]"
537+
"List[Dict[str,Any]]",
538+
"The resulting documentation from each file"
508539
],
509540
"line": 27,
510541
"children": []
@@ -515,4 +546,4 @@
515546
}
516547
}
517548
]
518-
}
549+
}

docs/tiny.markers.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,18 @@
5454
"type": "example",
5555
"arg": "required",
5656
"argc": 1
57+
},
58+
{
59+
"name": "author",
60+
"type": "author",
61+
"arg": "required",
62+
"argc": 1
63+
},
64+
{
65+
"name": "license",
66+
"type": "license",
67+
"arg": "required",
68+
"argc": 1
5769
}
5870
]
5971
}

tinydocs/__init__.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
from .markers import Marker, Argument
33
from .parser import Parser
44

5+
# @module tinydocs
6+
# @author Konstantinos Despoinidis (KDesp73)
7+
# @license MIT
8+
59
__version__ = "0.1.3"
610

711
__all__ = [

tinydocs/markers.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ def pattern(self):
6666

6767
# @method to_dict
6868
# @desc Serializes the marker instance into a dictionary
69-
# @returns Dict[str, Any]
69+
# @returns Dict[str,Any] Marker as a dictionary
7070
def to_dict(self):
7171
return {
7272
"prefix": self.prefix,

tinydocs/parser.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ def __init__(self, file: Path, comment: Optional[str] = "#", prefix: Optional[st
2424

2525
# @method parse
2626
# @param markers The list of markers to look for while parsing
27-
# @returns List[Dict[str, Any]]
27+
# @returns List[Dict[str,Any]] The resulting documentation from each file
2828
def parse(self, markers: List[Marker]) -> List[Dict[str, Any]]:
2929
# Ensure all markers have a prefix
3030
for marker in markers:

0 commit comments

Comments
 (0)