docs(E2E-docs): fixes links in Documentation and upgrades doc depende…

…ncies
MedVisBonn · Dec 4, 2023 · f7e80fc · f7e80fc
1 parent a70f08b
commit f7e80fc
Show file tree

Hide file tree

Showing 6 changed files with 148 additions and 303 deletions.
diff --git a/docs/formats/he_e2e.md b/docs/formats/he_e2e.md
@@ -69,7 +69,7 @@ First you might want to get an overview about the data stored in the hierarchy.
 from eyepy.io import HeE2eReader
 
 with HeE2eReader("filename.E2E") as e2e_reader:
-    print(e2e_reader.inspect(iterative=True)) # (1)
+    print(e2e_reader.inspect(recursive=True)) # (1)
 ```
 
 1.  This method is basically an extended version of `print(HeE2eReader("filename.E2E"))` that adds for every level of the hierarchy a table with information about the containded data.
@@ -90,7 +90,7 @@ classDiagram
     E2EStructureMixin <|-- E2ESliceStructure
 
     class E2EStructureMixin{
-      - inspect(interative, ind_prefix, tables)
+      - inspect(recursive, ind_prefix, tables)
       - get_folder_data(folder_type, offset, data_construct)
     }
 

diff --git a/docs/gen_e2e_doc.py b/docs/gen_e2e_doc.py
@@ -153,9 +153,9 @@ def _get_parses_to(type_annotation):
             offset = offset + size if (type(size) == int
                                        and type(offset) == int) else 'variable'
 
-with mkdocs_gen_files.open('formats/he_e2e_structures/SUMMARY.md',
-                           'w') as nav_file:
-    nav_file.writelines(nav.build_literate_nav())
+#with mkdocs_gen_files.open('formats/he_e2e_structures/SUMMARY.md',
+#                           'w') as nav_file:
+#    nav_file.writelines(nav.build_literate_nav())
 
 
 # Generate Documentation of E2E Hierarchy layers (E2EFile, E2EPatient, E2EStudy, E2ESeries, E2ESlice)
@@ -186,7 +186,7 @@ def _get_parses_to(type_annotation):
                 description = ''
 
             print(
-                f'|[{t} :material-link:](/formats/he_e2e_types/Type{t})|{content}|{size}|{description}|',
+                f'|[{t} :material-link:](../../../formats/he_e2e_types/Type{t}/)|{content}|{size}|{description}|',
                 file=fd)
 
 with mkdocs_gen_files.open('formats/he_e2e_hierarchy/SUMMARY.md',

diff --git a/docs/main.py b/docs/main.py
@@ -130,6 +130,7 @@ def get_hierarchy_doc(level_name):
                     description = ''
 
                 text += f'|[{t} :material-link:](/formats/he_e2e_types/Type{t})|{content}|{size}|{description}|\n'
+                #text += f'|[{t} :material-link:](../formats/he_e2e_types/Type{t}/popel/)|{content}|{size}|{description}|\n'
 
             return text
         raise ValueError(f'Level {level_name} not found in E2E hierarchy.')
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -85,8 +85,8 @@ markdown_extensions:
             format: !!python/name:pymdownx.superfences.fence_code_format
     - attr_list
     - pymdownx.emoji:
-        emoji_index: !!python/name:materialx.emoji.twemoji
-        emoji_generator: !!python/name:materialx.emoji.to_svg
+        emoji_index: !!python/name:material.extensions.emoji.twemoji
+        emoji_generator: !!python/name:material.extensions.emoji.to_svg
     - pymdownx.snippets:
         check_paths: true
         base_path: ['.', 'docs/']