Merge pull request #13 from JuliaComputing/apipage

add API page to docs
JuliaComputing · Sep 3, 2024 · 570aa20 · 570aa20
2 parents 64ee27f + 08c48c3
commit 570aa20
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -32,6 +32,7 @@ makedocs(;
                 "Controlled DC motor" => "examples/dc_motor_pi.md",
              ],
              "Block library" => "blocks.md",
+             "Functions" => "api.md",
          ],
 )
 

diff --git a/docs/src/api.md b/docs/src/api.md
@@ -0,0 +1,13 @@
+# API
+
+## Index
+```@index
+```
+
+## Docstrings
+
+```@docs
+ModelingToolkit.Sample
+ModelingToolkit.Hold
+ModelingToolkit.ShiftIndex
+```
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,6 +32,7 @@ makedocs(; @@
                     "Controlled DC motor" => "examples/dc_motor_pi.md",
                  ],
                  "Block library" => "blocks.md",
+                 "Functions" => "api.md",
              ],
     )
@@ Expand Down @@