various ci + docs edits

Author: jack-dunham

.github/workflows/documentation.yml

@@ -3,24 +3,34 @@ name: Documentation
 on:
   push:
     branches:
-      - main # update to match your development branch (master, main, dev, trunk, ...)
+      - dev # update to match your development branch (master, main, dev, trunk, ...)
     tags: '*'
   pull_request:
 
 jobs:
   build:
+    # These permissions are needed to:
+    # - Deploy the documentation: https://documenter.juliadocs.org/stable/man/hosting/#Permissions
+    # - Delete old caches: https://github.com/julia-actions/cache#usage
     permissions:
+      actions: write
       contents: write
+      pull-requests: read
+      statuses: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@v1
+      - uses: actions/checkout@v4
+      - uses: julia-actions/setup-julia@v2
         with:
-          version: '1.8'
+          version: '1'
+      - uses: julia-actions/cache@v2
       - name: Install dependencies
-        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        shell: julia --color=yes --project=docs {0}
+        run: |
+          using Pkg
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
       - name: Build and deploy
+        run: julia --color=yes --project=docs docs/make.jl
         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

.gitignore

@@ -2,3 +2,4 @@
 Manifest.toml
 .DS_Store
 *.cov
+docs/build/

README.md

@@ -1,5 +1,5 @@
 # TensorRenormalizationGroups.jl
 
-A Julia package for performing contractions of infinite two-dimensional tensor networks based on [TensorKit.jl](https://github.com/Jutho/TensorKit.jl).
+*A Julia package implementing various two-dimensional tensor renormalization group-like algorithms in an application agnostic way under a single interface. Based on [TensorKit.jl](https://github.com/Jutho/TensorKit.jl).*
 
-> This is alpha software and is currently incomplete.
+[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://jack-dunham.github.io/TensorRenormalizationGroups.jl/dev)

docs/Project.toml

@@ -1,2 +1,4 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+TensorKit = "07d1fe3e-3e46-537d-9eac-e9e13d0d4cec"
+TensorRenormalizationGroups = "742c4823-a45f-4b1c-bad3-1a5bdcda2a0b"

docs/make.jl

@@ -1,18 +1,17 @@
-push!(LOAD_PATH, "../src/")
-
 using Documenter
 using TensorRenormalizationGroups
 
 makedocs(
-    sitename = "TensorRenormalizationGroups.jl",
-    authors = "Jack Dunham",
-    pages = [
+    sitename="TensorRenormalizationGroups.jl",
+    authors="Jack Dunham",
+    pages=[
         "Home" => "index.md",
         "Library" => "library.md",
         "Index" => "_index.md"
     ]
 )
 
 deploydocs(
-    repo = "github.com/jack-dunham/TensorRenormalizationGroups.jl.git",
+    repo="github.com/jack-dunham/TensorRenormalizationGroups.jl.git",
+    devbranch="dev",
 )