Merge branch 'main' into dependabot/github_actions/crate-ci/typos-1.31.1

Author: oameye

.github/workflows/CI.yml

@@ -4,10 +4,10 @@ on:
     tags:
       - '*'
     branches:
-      - 'master'
+      - 'main'
   pull_request:
     branches:
-      - 'master'
+      - 'main'
 concurrency:
   # Skip intermediate builds: always.
   # Cancel intermediate builds: only if it is a pull request build.

.github/workflows/Documentation.yml

@@ -5,17 +5,18 @@ on:
     tags:
       - '*'
     branches:
-      - 'master'
+      - 'main'
   pull_request:
     branches:
-      - 'master'
+      - 'main'
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
 permissions:
   contents: write
   pages: write
   id-token: write
   statuses: write
+  pull-requests: read  # Required when using `push_preview=true`
 
 # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
 # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.

.github/workflows/downgrade.yml

@@ -4,10 +4,10 @@ on:
     tags:
       - '*'
     branches:
-      - 'master'
+      - 'main'
   pull_request:
     branches:
-      - 'master'
+      - 'main'
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}

Project.toml

@@ -11,17 +11,17 @@ SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
 Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
 
 [compat]
-DocStringExtensions = "0.9.3"
-SymbolicUtils = "3.11"
-Symbolics = "6.23"
-julia = "1.10.0"
-Random = "1.10.0"
-LinearAlgebra = "1.10.0"
-Test = "1.10.0"
-OrderedCollections = "1.6"
-Aqua = "0.8"
-ExplicitImports = "1.6"
-JET = "0.9.9"
+DocStringExtensions = "0.9.4"
+SymbolicUtils = "3.25"
+Symbolics = "6.36"
+julia = "1.10"
+Random = "1.10"
+LinearAlgebra = "1.10"
+Test = "1.10"
+OrderedCollections = "1.8"
+Aqua = "0.8.11"
+ExplicitImports = "1.11"
+JET = "0.9.18"
 CheckConcreteStructs = "0.1.0"
 
 [extras]

docs/make.jl

@@ -9,20 +9,21 @@ makedocs(;
     sitename="QuestBase.jl",
     authors="Quest group",
     modules=QuestBase,
-    format=Documenter.HTML(
-    canonical = "https://quantumengineeredsystems.github.io/QuestBase.jl/stable/"),
-    pages = pages,
-    clean = true,
-    linkcheck = true,
-    warnonly = :missing_docs,
+    format=Documenter.HTML(;
+        canonical="https://quantumengineeredsystems.github.io/QuestBase.jl/stable/"
+    ),
+    pages=pages,
+    clean=true,
+    linkcheck=true,
+    warnonly=:missing_docs,
     draft=!CI,
     doctest=false,  # We test it in the CI, no need to run it here
 )
 
 if CI
     deploydocs(;
-        repo="github.com/QuantumEngineeredSystems/QuestBase.jl";
-        # devbranch="master",
+        repo="github.com/QuantumEngineeredSystems/QuestBase.jl",
+        # devbranch="main",
         # target="build",
         # branch="gh-pages",
         push_preview=true,

docs/pages.jl

@@ -1,4 +1 @@
-pages = [
-    "Home" => "index.md",
-    "API" => "API.md"
-]
+pages = ["Home" => "index.md", "API" => "API.md"]

docs/src/API.md

@@ -1,6 +1,6 @@
 # API
 
-## Symbolic Utilies
+## Symbolic Utilities
 
 ```@docs
 

docs/src/index.md

@@ -1,6 +1,6 @@
 # The Common Interface for the QUEST ecosystem
 
-The QUEST common interface ties together the utilies of the ecosystem into a single unified interface.
+The QUEST common interface ties together the utilities of the ecosystem into a single unified interface.
 It is designed ensure compatiabilty between the different available packages.
 
 This documentation is made to pool together the docs of the various Quest libraries