Skip to content

Commit b8f284d

Browse files
committed
Add ISO Reference documentation
1 parent cac1512 commit b8f284d

File tree

4 files changed

+97
-0
lines changed

4 files changed

+97
-0
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Changelog
22

33
## [0.2.14] - Unreleased
4+
- Added ISO Reference documentation
45
- Removed non-standard conformance tests
56
- Improved documentation CSS
67

docs/changelog.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Changelog
22

33
## [0.2.14] - Unreleased
4+
- Added ISO Reference documentation
45
- Removed non-standard conformance tests
56
- Improved documentation CSS
67

docs/iso-reference.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# ISCC - ISO Reference
2+
3+
The following functions are the reference implementations of
4+
[ISO 24138](https://www.iso.org/standard/77899.html):
5+
6+
## ISO 24138 / 5.1 Meta-Code
7+
8+
::: iscc_core.gen_meta_code_v0
9+
options:
10+
show_root_heading: true
11+
show_root_full_path: false
12+
show_signature_annotations: false
13+
show_source: true
14+
heading_level: none
15+
16+
## ISO 24138 / 5.3 Text-Code
17+
18+
::: iscc_core.gen_text_code_v0
19+
options:
20+
show_root_heading: true
21+
show_root_full_path: false
22+
show_signature_annotations: false
23+
show_source: true
24+
heading_level: none
25+
26+
## ISO 24138 / 5.4 Image-Code
27+
28+
::: iscc_core.gen_image_code_v0
29+
options:
30+
show_root_heading: true
31+
show_root_full_path: false
32+
show_signature_annotations: false
33+
show_source: true
34+
heading_level: none
35+
36+
## ISO 24138 / 5.5 Audio-Code
37+
38+
::: iscc_core.gen_audio_code_v0
39+
options:
40+
show_root_heading: true
41+
show_root_full_path: false
42+
show_signature_annotations: false
43+
show_source: true
44+
heading_level: none
45+
46+
## ISO 24138 / 5.6 Video-Code
47+
48+
::: iscc_core.gen_video_code_v0
49+
options:
50+
show_root_heading: true
51+
show_root_full_path: false
52+
show_signature_annotations: false
53+
show_source: true
54+
heading_level: none
55+
56+
## ISO 24138 / 5.7 Mixed-Code
57+
58+
::: iscc_core.gen_mixed_code_v0
59+
options:
60+
show_root_heading: true
61+
show_root_full_path: false
62+
show_signature_annotations: false
63+
show_source: true
64+
heading_level: none
65+
66+
## ISO 24138 / 5.8 Data-Code
67+
68+
::: iscc_core.gen_data_code_v0
69+
options:
70+
show_root_heading: true
71+
show_root_full_path: false
72+
show_signature_annotations: false
73+
show_source: true
74+
heading_level: none
75+
76+
## ISO 24138 / 5.9 Instance-Code
77+
78+
::: iscc_core.gen_instance_code_v0
79+
options:
80+
show_root_heading: true
81+
show_root_full_path: false
82+
show_signature_annotations: false
83+
show_source: true
84+
heading_level: none
85+
86+
## ISO 24138 / 6.0 ISCC-CODE
87+
88+
::: iscc_core.gen_iscc_code_v0
89+
options:
90+
show_root_heading: true
91+
show_root_full_path: false
92+
show_signature_annotations: false
93+
show_source: true
94+
heading_level: none

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ markdown_extensions:
9393

9494
nav:
9595
- Overview: index.md
96+
- ISO Reference: iso-reference.md
9697
- Types: constants.md
9798
- Codec: codec/index.md
9899
- ISCC-UNITs:

0 commit comments

Comments
 (0)