make docs build

Author: oxinabox

docs/make.jl

@@ -1,67 +1,23 @@
-using ChainRulesCore
+using ChainRulesOverloadGeneration
+using ChainRulesCore: ChainRulesCore
 using Documenter
 using DocThemeIndigo
 using Markdown
 
-DocMeta.setdocmeta!(
-    ChainRulesOverloadGeneration,
-    :DocTestSetup,
-    quote
-        using Random
-        Random.seed!(0)  # frule doctest shows output
-
-        using ChainRulesCore
-        # These rules are all actually defined in ChainRules.jl, but we redefine them here to
-        # avoid the dependency.
-        @scalar_rule(sin(x), cos(x))  # frule and rrule doctest
-        @scalar_rule(sincos(x), @setup((sinx, cosx) = Ω), cosx, -sinx)  # frule doctest
-        @scalar_rule(hypot(x::Real, y::Real), (x / Ω, y / Ω))  # rrule doctest
-    end
-)
-
 indigo = DocThemeIndigo.install(ChainRulesOverloadGeneration)
 
 makedocs(
     modules=[ChainRulesOverloadGeneration],
     format=Documenter.HTML(
         prettyurls=false,
         assets=[indigo],
-        mathengine=MathJax3(
-            Dict(
-                :tex => Dict(
-                    "inlineMath" => [["\$","\$"], ["\\(","\\)"]],
-                    "tags" => "ams",
-                    # TODO: remove when using physics package
-                    "macros" => Dict(
-                        "ip" => ["{\\left\\langle #1, #2 \\right\\rangle}", 2],
-                        "Re" => "{\\operatorname{Re}}",
-                        "Im" => "{\\operatorname{Im}}",
-                        "tr" => "{\\operatorname{tr}}",
-                    ),
-                ),
-            ),
-        ),
     ),
     sitename="ChainRules",
-    authors="Jarrett Revels and other contributors",
+    authors="Lyndon White and other contributors",
     pages=[
         "Introduction" => "index.md",
-        "FAQ" => "FAQ.md",
-        "Writing Good Rules" => "writing_good_rules.md",
-        "Complex Numbers" => "complex.md",
-        "Deriving Array Rules" => "arrays.md",
-        "Debug Mode" => "debug_mode.md",
-        "Gradient Accumulation" => "gradient_accumulation.md",
-        "Usage in AD" => [
-            "Overview" => "autodiff/overview.md",
-            "Operator Overloading" => "autodiff/operator_overloading.md",
-        ],
-        "Design" => [
-            "Changing the Primal" => "design/changing_the_primal.md",
-            "Many Differential Types" => "design/many_differentials.md",
-        ],
         "API" => "api.md",
-    ],
+       ],
     strict=true,
     checkdocs=:exports,
 )

docs/src/api.md

@@ -2,7 +2,7 @@
 
 ```@autodocs
 Modules = [ChainRulesOverloadGeneration]
-Pages = ["rule_definition_tools.jl"]
+Pages = ["ruleset_loading.jl"]
 Private = false
 ```
 

docs/src/autodiff/operator_overloading.md docs/src/index.mddocs/src/autodiff/operator_overloading.md renamed to docs/src/index.md

@@ -1,4 +1,8 @@
-# Operator Overloading
+# Operator Overloading AD with ChainRulesOverloadGeneration.jl
+
+The ChainRulesOverloadGeneration package provides a suite of methods for using [ChainRulesCore.jl](https://github.com/JuliaDiff/ChainRulesCore.jl) rules in operator overloaded based AD systems.
+It tracks what rules are defined at any point in time, and lets you trigger functions to which can use `@eval` in order to define the matching operator overloads.
+
 
 The principal interface for using the operator overload generation method is [`on_new_rule`](@ref).
 This function allows one to register a hook to be run every time a new rule is defined.
@@ -14,7 +18,7 @@ or more simply you can just use conditions for this.
 For example if your AD only supports `AbstractMatrix{Float64}` and `Float64` inputs you might write:
 ```julia
 const ACCEPT_TYPE = Union{Float64, AbstractMatrix{Float64}} 
-function define_overload(sig::Type{<:Tuple{F, Vararg{ACCEPT_TYPE}}) where F
+function define_overload(sig::Type{<:Tuple{F, Vararg{ACCEPT_TYPE}}}) where F
     @eval quote
         # ...
     end
@@ -54,6 +58,7 @@ When the rules are refreshed (automatically or manually), the hooks are only tri
 It is useful to undo [`on_new_rule`] hook registration if you are iteratively developing your overload generation function.
 
 ## Examples
+Here we define two fairly simplistic operator overloading based AD Systems to demonstrate how this is used.
 
 ### ForwardDiffZero
 The overload generation hook in this example is: `define_dual_overload`.
@@ -62,7 +67,7 @@ The overload generation hook in this example is: `define_dual_overload`.
 using Markdown
 Markdown.parse("""
 ```julia
-$(read(joinpath(@__DIR__,"../../../test/demos/forwarddiffzero.jl"), String))
+$(read(joinpath(@__DIR__,"../../test/demos/forwarddiffzero.jl"), String))
 ```
 """)
 ````
@@ -74,7 +79,7 @@ The overload generation hook in this example is: `define_tracked_overload`.
 using Markdown
 Markdown.parse("""
 ```julia
-$(read(joinpath(@__DIR__,"../../../test/demos/reversediffzero.jl"), String))
+$(read(joinpath(@__DIR__,"../../test/demos/reversediffzero.jl"), String))
 ```
 """)
 ````