Merge branch 'master' of https://github.com/TuringLang/DynamicPPL.jl into tor/benchmark-update

Author: shravanngoswamii

.github/workflows/CI.yml

@@ -6,9 +6,6 @@ on:
       - master
       - backport-*
   pull_request:
-    branches:
-      - master
-      - backport-*
   merge_group:
     types: [checks_requested]
 

.github/workflows/Docs.yml

@@ -6,8 +6,6 @@ on:
       - master
     tags: '*'
   pull_request:
-    branches:
-      - master
   merge_group:
     types: [checks_requested]
 
@@ -17,19 +15,14 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 
+permissions:
+  contents: write
+  pull-requests: read
+
 jobs:
   docs:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: julia-actions/setup-julia@v2
-        with:
-          version: '1'
-      - 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 }} # For authentication with GitHub Actions token
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-          JULIA_DEBUG: Documenter # Print `@debug` statements (https://github.com/JuliaDocs/Documenter.jl/issues/955)
-        run: julia --project=docs/ docs/make.jl
+      - name: Build and deploy Documenter.jl docs
+        uses: TuringLang/actions/DocsDocumenter@main

.github/workflows/DocsNav.yml

@@ -1,49 +1,39 @@
-name: Add Navbar
+name: Rebuild docs with newest navbar
 
 on:
-  page_build:  # Triggers the workflow on push events to gh-pages branch
-  workflow_dispatch:  # Allows manual triggering
+  # 3:25 AM UTC every Sunday -- choose an uncommon time to avoid
+  # periods of heavy GitHub Actions usage
   schedule:
-    - cron: '0 0 * * 0'  # Runs every week on Sunday at midnight (UTC)
+    - cron: '25 3 * * 0'
+  # Whenever needed
+  workflow_dispatch:
+
+permissions:
+  contents: write
 
 jobs:
-  add-navbar:
+  update-navbar:
     runs-on: ubuntu-latest
-    permissions:
-      contents: write
+
     steps:
-      - name: Checkout gh-pages
+      - name: Checkout gh-pages branch
         uses: actions/checkout@v4
         with:
           ref: gh-pages
-          fetch-depth: 0
 
-      - name: Download insert_navbar.sh
-        run: |
-          curl -O https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/insert_navbar.sh
-          chmod +x insert_navbar.sh
+      - name: Insert navbar
+        uses: TuringLang/actions/DocsNav@main
+        with:
+          doc-path: '.'
 
-      - name: Update Navbar
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Commit and push changes
         run: |
-          git config user.name github-actions[bot]
-          git config user.email github-actions[bot]@users.noreply.github.com
-
-          # Define the URL of the navbar to be used
-          NAVBAR_URL="https://raw.githubusercontent.com/TuringLang/turinglang.github.io/main/assets/scripts/TuringNavbar.html"
-         
-          # Update all HTML files in the current directory (gh-pages root)
-          ./insert_navbar.sh . $NAVBAR_URL
-         
-          # Remove the insert_navbar.sh file
-          rm insert_navbar.sh
-         
-          # Check if there are any changes
           if [[ -n $(git status -s) ]]; then
-            git add .
-            git commit -m "Added navbar and removed insert_navbar.sh"
-            git push "https://${GITHUB_ACTOR}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" gh-pages
+            git config --global user.email "github-actions[bot]@users.noreply.github.com"
+            git config --global user.name "GitHub Actions"
+            git add -A
+            git commit -m "Update navbar (automated)"
+            git push
           else
             echo "No changes to commit"
           fi

.github/workflows/Format.yml

@@ -5,8 +5,6 @@ on:
     branches:
       - master
   pull_request:
-    branches:
-      - master
   merge_group:
     types: [checks_requested]
 

Project.toml

@@ -15,8 +15,6 @@ ConstructionBase = "187b0558-2788-49d3-abe0-74a17ed4e7c9"
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 InteractiveUtils = "b77e0a4c-d291-57a0-90e8-8db25a27a240"
-# TODO(penelopeysm,mhauru) KernelAbstractions is only a dependency so that we can pin its version, see
-# https://github.com/TuringLang/DynamicPPL.jl/pull/781#event-16017866767
 KernelAbstractions = "63c18a36-062a-441e-b654-da1e3ab1ce7c"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 LogDensityProblems = "6fdf6af0-433a-55f7-b3ed-c6c6e0b8df7c"
@@ -58,9 +56,7 @@ Compat = "4"
 ConstructionBase = "1.5.4"
 Distributions = "0.25"
 DocStringExtensions = "0.9"
-# TODO(penelopeysm,mhauru) See https://github.com/TuringLang/DynamicPPL.jl/pull/781#event-16017866767
-# for why KernelAbstractions is pinned like this.
-KernelAbstractions = "< 0.9.32"
+KernelAbstractions = "0.9.33"
 EnzymeCore = "0.6 - 0.8"
 ForwardDiff = "0.10"
 JET = "0.9"

docs/make.jl

@@ -20,12 +20,8 @@ makedocs(;
     format=Documenter.HTML(; size_threshold=2^10 * 400),
     modules=[DynamicPPL],
     pages=[
-        "Home" => "index.md",
-        "API" => "api.md",
-        "Internals" => ["internals/varinfo.md", "internals/transformations.md"],
+        "Home" => "index.md", "API" => "api.md", "Internals" => ["internals/varinfo.md"]
     ],
     checkdocs=:exports,
     doctest=false,
 )
-
-deploydocs(; repo="github.com/TuringLang/DynamicPPL.jl.git", push_preview=true)

docs/src/api.md

@@ -279,7 +279,7 @@ VarInfo
 TypedVarInfo
 ```
 
-One main characteristic of [`VarInfo`](@ref) is that samples are transformed to unconstrained Euclidean space and stored in a linearized form, as described in the [transformation page](internals/transformations.md).
+One main characteristic of [`VarInfo`](@ref) is that samples are transformed to unconstrained Euclidean space and stored in a linearized form, as described in the [main Turing documentation](https://turinglang.org/docs/developers/transforms/dynamicppl/).
 The [Transformations section below](#Transformations) describes the methods used for this.
 In the specific case of `VarInfo`, it keeps track of whether samples have been transformed by setting flags on them, using the following functions.