Add outline to docs (#42)

* Add manual outline
* Fix to build stable docs

Author: adrhill

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
   push:
     branches:
       - master
+    tags: '*'
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}

docs/literate/example.jl

@@ -35,7 +35,7 @@ x, y = MNIST.testdata(Float32, index)
 
 MNIST.convert2image(x)
 
-# By convention in Flux.jl, this input needs to be resized to to WHCN format by adding a color channel and batch dimensions.
+# By convention in Flux.jl, this input needs to be resized to WHCN format by adding a color channel and batch dimensions.
 input = reshape(x, 28, 28, 1, :);
 
 #md # !!! warning "Input format"

docs/src/api.md

@@ -1,12 +1,11 @@
-# API Reference
-
+# Basics
 All methods in ExplainabilityMethods.jl work by calling `analyze` on an input and an analyzer:
 ```@docs
 analyze
 heatmap
 ```
 
-## Analyzers
+# Analyzers
 ```@docs
 LRP
 Gradient

docs/src/index.md

@@ -11,3 +11,18 @@ To install this package and its dependencies, open the Julia REPL and run
 ```julia-repl
 julia> ]add ExplainabilityMethods
 ```
+
+## Manual
+```@contents
+Pages = [
+    "generated/example.md",
+    "generated/advanced_lrp.md",
+]
+Depth = 2
+```
+
+## API reference
+```@contents
+Pages = ["api.md",]
+Depth = 2
+```

src/heatmap.jl

@@ -10,11 +10,12 @@ const HEATMAPPING_PRESETS = Dict{Symbol,Tuple{ColorScheme,Symbol,Symbol}}(
 """
     heatmap(expl::Explanation; kwargs...)
     heatmap(attr::AbstractArray; kwargs...)
+
     heatmap(input, analyzer::AbstractXAIMethod)
     heatmap(input, analyzer::AbstractXAIMethod, neuron_selection::Int)
 
 Visualize explanation.
-Assumes the Flux's WHCN convention (width, height, color channels, batch size).
+Assumes Flux's WHCN convention (width, height, color channels, batch size).
 
 ## Keyword arguments
 - `cs::ColorScheme`: ColorScheme that is applied.