Refactor file paths in documentation to use 'library' directory

aadimator · Aug 8, 2024 · 69d2ec2 · 69d2ec2
1 parent 9c99d48
commit 69d2ec2
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 5 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -19,9 +19,9 @@ makedocs(;
         "Basic Usage" => "man/basics.md",
         "Convert Seurat Objects" => "man/seurat_conversion.md",
         "API" => Any[
-            "Types" => "lib/types.md",
-            "Functions" => "lib/functions.md",
-            hide("Internals" => "lib/internals.md"),
+            "Types" => "library/types.md",
+            "Functions" => "library/functions.md",
+            # hide("Internals" => "lib/internals.md"),
         ]
     ],
 )

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -15,6 +15,5 @@ Depth = 2
 ## Index
 
 ```@index
-Pages = ["lib/types.md", "lib/functions.md"]
+Pages = ["library/types.md", "library/functions.md"]
 ```
-
diff --git a/docs/src/library/functions.md b/docs/src/library/functions.md
@@ -0,0 +1,8 @@
+```@index
+Pages = ["functions.md"]
+```
+
+```@autodocs
+Modules = [ISCHIA]
+Filter = t -> typeof(t) !== CooccurOutput
+```
diff --git a/docs/src/library/types.md b/docs/src/library/types.md
@@ -0,0 +1,7 @@
+```@index
+Pages = ["types.md"]
+```
+
+```@docs
+CooccurOutput
+```