Updated API page in docs

TRACER-LULab · Oct 13, 2023 · 5eec5df · 5eec5df
1 parent 20761f0
commit 5eec5df
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
@@ -170,9 +170,9 @@ version = "0.5.1"
 
 [[deps.ChainRulesCore]]
 deps = ["Compat", "LinearAlgebra", "SparseArrays"]
-git-tree-sha1 = "e30f2f4e20f7f186dc36529910beaedc60cfa644"
+git-tree-sha1 = "b66b8f8e3db5d7835fb8cbe2589ffd1cd456e491"
 uuid = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4"
-version = "1.16.0"
+version = "1.17.0"
 
 [[deps.CodecZlib]]
 deps = ["TranscodingStreams", "Zlib_jll"]
@@ -328,9 +328,9 @@ version = "0.9.3"
 
 [[deps.Documenter]]
 deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "Dates", "DocStringExtensions", "Downloads", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "Test", "Unicode"]
-git-tree-sha1 = "f667b805e90d643aeb1ca70189827f991a7cc115"
+git-tree-sha1 = "147a3cbb6ddcd9448fe5e6c426b347efc68f9c86"
 uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-version = "1.1.0"
+version = "1.1.1"
 
 [[deps.DocumenterCitations]]
 deps = ["AbstractTrees", "Bibliography", "Documenter", "Markdown", "MarkdownAST", "OrderedCollections", "Unicode"]
@@ -695,7 +695,7 @@ weakdeps = ["Statistics"]
     IntervalSetsStatisticsExt = "Statistics"
 
 [[deps.InverseLangevinApproximations]]
-deps = ["InteractiveUtils"]
+deps = ["DocStringExtensions", "InteractiveUtils"]
 path = "/home/carson/.julia/dev/InverseLangevinApproximations"
 uuid = "b82787f2-62be-403e-9078-6d9feafd7ee3"
 version = "0.1.0"
@@ -1141,9 +1141,9 @@ version = "10.42.0+0"
 
 [[deps.PDMats]]
 deps = ["LinearAlgebra", "SparseArrays", "SuiteSparse"]
-git-tree-sha1 = "fcf8fd477bd7f33cb8dbb1243653fb0d415c256c"
+git-tree-sha1 = "3d8af7d689bd228a3a6c2298a4e6d5f5944accb8"
 uuid = "90014a1f-27ba-587c-ab20-58faa44d9150"
-version = "0.11.25"
+version = "0.11.26"
 
 [[deps.PNGFiles]]
 deps = ["Base64", "CEnum", "ImageCore", "IndirectArrays", "OffsetArrays", "libpng_jll"]

diff --git a/docs/make.jl b/docs/make.jl
@@ -23,7 +23,7 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
-        "Approximations" => "methods.md"
+        "API" => "methods.md"
     ],
 )
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -20,10 +20,10 @@ x_true = range(0.0, 10.0, length = 101)
 y = L.(x_true)
 use_model(x) = Base.isexported(InverseLangevinApproximations, Symbol(x))
 fs = filter(use_model, subtypes(InverseLangevinApproximations.AbstractInverseLangevinApproximation))
-f = Figure(resolution = (1000, 1000))
+f = Figure(resolution = (750, 750))
 ax = Axis(f[1, 1], xlabel = "y", ylabel = "Relative Error", xticks = 0:0.2:1.0)
 for f in fs
-    x = inverse_langevin_approximation.(f(), y)
+    x = inverse_langevin_approximation.(y, f())
     rel_error = abs.((x .- x_true) ./ x_true)
     lines!(ax, y, rel_error, label = string(f))
 end

diff --git a/docs/src/methods.md b/docs/src/methods.md
@@ -18,7 +18,7 @@ Order = [:function]
 
 ```@autodocs
 Modules = [InverseLangevinApproximations]
-Filter = x -> typeof(x) === UnionAll && x <:InverseLangevinApproximations.AbstractInverseLangevinApproximation
+Filter = x -> typeof(x)===DataType && x <:InverseLangevinApproximations.AbstractInverseLangevinApproximation
 ```
 
 # References
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,7 @@ makedocs(; @@
         ),
         pages=[
             "Home" => "index.md",
-            "Approximations" => "methods.md"
+            "API" => "methods.md"
         ],
     )
@@ Expand Down @@