Add Symbolics to backend docs (#247)

Author: gdalle

DifferentiationInterface/docs/src/backends.md

@@ -7,7 +7,19 @@ CollapsedDocStrings = true
 using DifferentiationInterface
 using DifferentiationInterface: backend_str
 import Markdown
-import Diffractor, Enzyme, FastDifferentiation, FiniteDiff, FiniteDifferences, ForwardDiff, PolyesterForwardDiff, ReverseDiff, Tapir, Tracker, Zygote
+
+import Diffractor
+import Enzyme
+import FastDifferentiation
+import FiniteDiff
+import FiniteDifferences
+import ForwardDiff
+import PolyesterForwardDiff
+import ReverseDiff
+import Symbolics
+import Tapir
+import Tracker
+import Zygote
 
 const backend_examples = (
     "AutoDiffractor()",
@@ -19,6 +31,7 @@ const backend_examples = (
     "AutoForwardDiff()",
     "AutoPolyesterForwardDiff(; chunksize=1)",
     "AutoReverseDiff()",
+    "AutoSymbolics()",
     "AutoTapir()",
     "AutoTracker()",
     "AutoZygote()",

DifferentiationInterface/docs/src/overloads.md

@@ -1,7 +1,8 @@
 # Table of overloads
 
 As described in the [overview](@ref sec-overview), DifferentiationInterface provides multiple high-level operators like [`jacobian`](@ref),
-each with several variants: 
+each with several variants:
+
 * **out-of-place** or **in-place** return values
 * **with** or **without primal** output value
 * support for **one-argument functions** `y = f(x)` or **two-argument functions** `f!(y, x)`
@@ -14,9 +15,9 @@ When available, DifferentiationInterface **always** calls these backend-specific
 The following tables summarize all implemented overloads for each backend.
 Each cell can have three values:
 
-- ❌: the operator is not overloaded because the backend does not support it
-- ✅: the operator is overloaded
-- NA: the operator does not exist
+* ❌: the operator is not overloaded because the backend does not support it
+* ✅: the operator is overloaded
+* NA: the operator does not exist
 
 !!! tip
     Check marks (✅) are clickable and link to the source code.
@@ -26,13 +27,15 @@ using ADTypes: AbstractADType
 using DifferentiationInterface
 using DifferentiationInterface: backend_str, twoarg_support, TwoArgSupported
 using Markdown: Markdown
+
 using Diffractor: Diffractor
 using Enzyme: Enzyme
 using FastDifferentiation: FastDifferentiation
 using FiniteDiff: FiniteDiff
 using FiniteDifferences: FiniteDifferences
 using ForwardDiff: ForwardDiff
 using PolyesterForwardDiff: PolyesterForwardDiff
+using Symbolics: Symbolics
 using ReverseDiff: ReverseDiff
 using Tapir: Tapir
 using Tracker: Tracker
@@ -88,6 +91,7 @@ function operators_and_types_f(backend::T) where {T<:AbstractADType}
         ),
     )
 end
+
 function operators_and_types_f!(backend::T) where {T<:AbstractADType}
     return (
         (
@@ -166,61 +170,79 @@ end
 ```
 
 ## Diffractor (forward/reverse)
+
 ```@example overloads
 print_overloads(AutoDiffractor(), :DifferentiationInterfaceDiffractorExt) # hide
 ```
 
 ## Enzyme (forward)
+
 ```@example overloads
 print_overloads(AutoEnzyme(; mode=Enzyme.Forward), :DifferentiationInterfaceEnzymeExt) # hide
 ```
 
 ## Enzyme (reverse)
+
 ```@example overloads
 print_overloads(AutoEnzyme(; mode=Enzyme.Reverse), :DifferentiationInterfaceEnzymeExt) # hide
 ```
 
 ## FastDifferentiation (symbolic)
+
 ```@example overloads
 print_overloads(AutoFastDifferentiation(), :DifferentiationInterfaceFastDifferentiationExt) # hide
 ```
 
 ## FiniteDiff (forward)
+
 ```@example overloads
 print_overloads(AutoFiniteDiff(), :DifferentiationInterfaceFiniteDiffExt) # hide
 ```
 
 ## FiniteDifferences (forward)
+
 ```@example overloads
 print_overloads(AutoFiniteDifferences(; fdm=FiniteDifferences.central_fdm(3, 1)), :DifferentiationInterfaceFiniteDifferencesExt) # hide
 ```
 
 ## ForwardDiff (forward)
+
 ```@example overloads
 print_overloads(AutoForwardDiff(), :DifferentiationInterfaceForwardDiffExt) # hide
 ```
 
 ## PolyesterForwardDiff (forward)
+
 ```@example overloads
 print_overloads(AutoPolyesterForwardDiff(; chunksize=1), :DifferentiationInterfacePolyesterForwardDiffExt) # hide
 ```
 
 ## ReverseDiff (reverse)
+
 ```@example overloads
 print_overloads(AutoReverseDiff(), :DifferentiationInterfaceReverseDiffExt) # hide
 ```
 
+## Symbolics (symbolic)
+
+```@example overloads
+print_overloads(AutoSymbolics(), :DifferentiationInterfaceSymbolicsExt) # hide
+```
+
 ## Tapir (reverse)
+
 ```@example overloads
 print_overloads(AutoTapir(), :DifferentiationInterfaceTapirExt) # hide
 ```
 
 ## Tracker (reverse)
+
 ```@example overloads
 print_overloads(AutoTracker(), :DifferentiationInterfaceTrackerExt) # hide
 ```
 
 ## Zygote (reverse)
+
 ```@example overloads
 print_overloads(AutoZygote(), :DifferentiationInterfaceZygoteExt) # hide
 ```