docs: build and deploy docs

.github/workflows/documentation.yml

@@ -0,0 +1,38 @@
+name: Documentation
+
+permissions:
+  contents: write  # Required when authenticating with `GITHUB_TOKEN`, not needed when authenticating with SSH deploy keys
+  pull-requests: read  # Required when using `push_preview=true`
+  statuses: write  # Optional, used to report documentation build statuses
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1.10'
+      - uses: julia-actions/cache@v1
+      - name: Install dependencies
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

docs/Project.toml

@@ -1,8 +1,9 @@
 [deps]
 ABCredit = "91b5283e-3ff1-4617-8122-130c88cb8aba"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+HPFilter = "d73ad930-938d-4709-8eff-50e740f82fcd"
+KernelDensity = "5ab0869b-81aa-558d-bb23-cbf5423bbe9b"
 Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
-LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 StatsPlots = "f3b207a7-027a-5e70-b257-86293d7955fd"

docs/make.jl

@@ -12,7 +12,7 @@ rm(outdir; force = true, recursive = true) # cleans up previous examples
 mkpath(outdir)
 
 Literate.markdown(joinpath(indir, "basic_example.jl"), outdir; credit = false)
-Literate.markdown(joinpath(indir, "compare_histograms.jl"), outdir; credit = false)
+# Literate.markdown(joinpath(indir, "compare_histograms.jl"), outdir; credit = false)
 Literate.markdown(joinpath(indir, "parallel_evaluations.jl"), outdir; credit = false)
 
 println("Documentation Build")
@@ -23,9 +23,9 @@ makedocs(
     pages = [
         "Home" => "index.md",
         "Essentials" => "examples/basic_example.md",
-        "Model and data" => "examples/compare_histograms.md",
+        # "Model and data" => "examples/compare_histograms.md",
         "Parallel evaluations" => "examples/parallel_evaluations.md",
-        "Runs from the terminal" => "running_from_the_terminal.md",
+        "Runs from the terminal" => "running_from_terminal.md",
         "Code reference" => "api.md",
     ],
 )

docs/src/index.md

@@ -10,7 +10,7 @@ A fast, and simple to use, Julia implementation of the model in _Emergent dynami
 
 ```julia
 using Pkg
-Pkg.add(url="[email protected]:bancaditalia/ABCredit.jl.git")
+Pkg.add("ABCredit")
 ```
 
 ## Quick example

examples/basic_example.jl

@@ -37,7 +37,7 @@ model.params[:subsidy] = 0.0
 # Now we run the mdel for T epochs, the results simulation will output a data collector "d" with several time series.
 
 T = 1000
-d = ABCredit.run_one_sim!(model, T; seed = 100)
+d = ABCredit.run_one_sim!(model, T; seed = 100, burn_in = 100)
 
 # If needed, we can save the simulation data to a CSV file as
 

examples/parallel_evaluations.jl

@@ -2,7 +2,7 @@
 
 # import ABCredit.jl and other useful libraries
 
-using ABCredit, StatsPlots, CSV, DataFrames
+using ABCredit, StatsPlots
 
 params = ABCredit.PARAMS_ORIGINAL