sprucing up docs

Forced-Alignment-and-Vowel-Extraction · May 18, 2024 · b08dcb7 · b08dcb7
1 parent ce07e95
commit b08dcb7
Show file tree

Hide file tree

Showing 24 changed files with 31 additions and 804 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,5 @@
 /.quarto/
-_site/
+_site/
+_inv/
+objects.txt
+reference/
diff --git a/docs/_quarto.yml b/docs/_quarto.yml
@@ -3,6 +3,7 @@ project:
   output-dir: _site
 
 website:
+  title: fave-recode
   page-navigation: true
   image: assets/logo.png
   favicon: assets/logo.png
@@ -47,23 +48,28 @@ format:
       dark: [darkly, styles/dark.scss]
     css: styles/styles.css
     toc: true
-    filters: 
-      - codeblocklabel
+
 
 # tell quarto to read the generated sidebar
 metadata-files:
   - reference/_sidebar.yml
 
 filters:
   - "interlinks"
+  - codeblocklabel
 
 interlinks:
+  fast: true
   sources:
+    numpy:
+      url: https://numpy.org/doc/stable/
     python:
       url: https://docs.python.org/3/
-    griffe:
-      url: https://mkdocstrings.github.io/griffe/
+    aligned_textgrid:
+      url: https://forced-alignment-and-vowel-extraction.github.io/alignedTextGrid/ 
 
+resources: 
+  - objects.inv
 
 quartodoc:
   # the name used to import the package you want to create reference docs for

diff --git a/docs/objects.py b/docs/objects.py
@@ -0,0 +1,17 @@
+import fave_recode
+import sphobjinv as soi
+from pathlib import Path
+inv = soi.Inventory(fname_plain = Path("objects.txt"))
+
+for idx in range(len(inv.objects)):
+    obj = inv.objects[idx]
+    basename = obj.name.split(".")[-1]
+    if hasattr(fave_recode, basename):
+        obj_dict = obj.json_dict()
+        obj_dict["name"] = "fave_recode." + basename
+        new_obj = soi.DataObjStr(**obj_dict)
+        inv.objects.append(new_obj)
+
+df = inv.data_file()
+dfc = soi.compress(df)
+soi.writebytes("objects.inv", dfc)
diff --git a/docs/reference/_sidebar.yml b/docs/reference/_sidebar.yml
diff --git a/docs/reference/fave_recode.relations.contains_relation.qmd b/docs/reference/fave_recode.relations.contains_relation.qmd
diff --git a/docs/reference/fave_recode.relations.equals_relation.qmd b/docs/reference/fave_recode.relations.equals_relation.qmd
diff --git a/docs/reference/fave_recode.relations.excludes_relation.qmd b/docs/reference/fave_recode.relations.excludes_relation.qmd
diff --git a/docs/reference/fave_recode.relations.in_relation.qmd b/docs/reference/fave_recode.relations.in_relation.qmd
diff --git a/docs/reference/fave_recode.relations.negate.qmd b/docs/reference/fave_recode.relations.negate.qmd
diff --git a/docs/reference/fave_recode.relations.not_in_relation.qmd b/docs/reference/fave_recode.relations.not_in_relation.qmd
diff --git a/docs/reference/fave_recode.relations.rematches_relation.qmd b/docs/reference/fave_recode.relations.rematches_relation.qmd
diff --git a/docs/reference/index.qmd b/docs/reference/index.qmd
diff --git a/docs/reference/labelset_parser.LabelSetParser.qmd b/docs/reference/labelset_parser.LabelSetParser.qmd