You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Restructure documentation to remove API reference level
- Moved API reference content to index page (generated from make.jl)
- Removed separate API reference page level from navigation
- Reorganized all pages to show summaries before docstrings
- Updated pages.jl to have flat navigation structure
- All category pages now appear directly in sidebar
- Index page contains comprehensive API guidance and navigation
Documentation structure now follows:
- Home (with API reference) → Category pages directly
- Each page: Summary/Notes → Functions → Cache
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/make.jl
+44Lines changed: 44 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,50 @@ open(joinpath(@__DIR__, "src", "index.md"), "w") do io
23
23
for line ineachline(joinpath(dirname(@__DIR__), "README.md"))
24
24
println(io, line)
25
25
end
26
+
27
+
# Add API reference content
28
+
println(io, "")
29
+
println(io, "## API Reference")
30
+
println(io, "")
31
+
println(io, "```@docs")
32
+
println(io, "FiniteDiff")
33
+
println(io, "```")
34
+
println(io, "")
35
+
println(io, "FiniteDiff.jl provides fast, non-allocating finite difference calculations with support for sparsity patterns and various array types. The API is organized into several categories:")
36
+
println(io, "")
37
+
println(io, "### Function Categories")
38
+
println(io, "")
39
+
println(io, "- **[Derivatives](@ref derivatives)**: Single and multi-point derivatives of scalar functions")
40
+
println(io, "- **[Gradients](@ref gradients)**: Gradients of scalar-valued functions with respect to vector inputs")
41
+
println(io, "- **[Jacobians](@ref jacobians)**: Jacobian matrices of vector-valued functions, including sparse Jacobian support")
42
+
println(io, "- **[Hessians](@ref hessians)**: Hessian matrices of scalar-valued functions")
43
+
println(io, "- **[Jacobian-Vector Products](@ref jvp)**: Efficient computation of directional derivatives without forming full Jacobians")
44
+
println(io, "- **[Utilities](@ref utilities)**: Internal utilities and helper functions")
45
+
println(io, "")
46
+
println(io, "### Quick Start")
47
+
println(io, "")
48
+
println(io, "All functions follow a consistent API pattern:")
Copy file name to clipboardExpand all lines: docs/src/jvp.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,19 +2,6 @@
2
2
3
3
Functions for computing Jacobian-vector products efficiently without forming the full Jacobian matrix.
4
4
5
-
## Functions
6
-
7
-
```@docs
8
-
FiniteDiff.finite_difference_jvp
9
-
FiniteDiff.finite_difference_jvp!
10
-
```
11
-
12
-
## Cache
13
-
14
-
```@docs
15
-
FiniteDiff.JVPCache
16
-
```
17
-
18
5
## Mathematical Background
19
6
20
7
The JVP computes `J(x) * v` where `J(x)` is the Jacobian of function `f` at point `x` and `v` is a direction vector. This is computed using finite difference approximations:
@@ -45,4 +32,17 @@ JVP is particularly useful for:
45
32
## Limitations
46
33
47
34
-**Complex step**: JVP does not currently support complex step differentiation (`Val(:complex)`)
48
-
-**In-place functions**: For in-place function evaluation, ensure proper cache sizing
35
+
-**In-place functions**: For in-place function evaluation, ensure proper cache sizing
0 commit comments