Move docstrings to separate API page

dahong67 · Oct 9, 2023 · 1235c61 · 1235c61
1 parent 70678d2
commit 1235c61
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 10 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -16,6 +16,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "API Reference" => "api.md",
     ],
 )
 

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -0,0 +1,3 @@
+```@autodocs
+Modules = [GCPDecompositions]
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -49,13 +49,3 @@ In BibTeX form:
   DOI =          "10.1137/19M1266265",
 }
 ```
-
-## Docstrings
-
-```@index
-```
-
-```@autodocs
-Modules = [GCPDecompositions]
-Filter = t -> t !== ncomponents
-```
-Original file line number
+Diff line change
@@ Expand Up / @@ -16,6 +16,7 @@ makedocs(; @@
         ),
         pages=[
             "Home" => "index.md",
+            "API Reference" => "api.md",
         ],
     )
@@ Expand Down @@