Update Rendering and introduce DC examples (#7)

* bump version.

...and test that caches trigger.

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        julia-version: ["1.8", "~1.9.0-0"]
+        julia-version: ["1.8", "1.9"]
         os: [ubuntu-latest, macOS-latest, windows-latest]
     steps:
       - uses: actions/checkout@v2
@@ -27,4 +27,4 @@ jobs:
           file: ./lcov.info
           name: codecov-umbrella
           fail_ci_if_error: false
-        if: ${{ matrix.julia-version == '1.8' && matrix.os =='ubuntu-latest' }}
+        if: ${{ matrix.os =='ubuntu-latest' }}

.github/workflows/clear_preview.yml

@@ -0,0 +1,26 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

.github/workflows/documenter.yml

@@ -10,11 +10,47 @@ jobs:
     name: Documentation
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
+      - uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: 1.3.361
       - uses: julia-actions/setup-julia@latest
         with:
-          version: 1.8
-      - uses: julia-actions/julia-docdeploy@releases/v1
+          version: 1.9
+      - name: Julia Cache
+        uses: julia-actions/cache@v1
+      - name: Cache Quarto
+        id: cache-quarto
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-quarto
+        with:
+          path: examples/_freeze
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('examples/*.qmd') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: Cache Documenter
+        id: cache-documenter
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-documenter
+        with:
+          path: docs/src/examples
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('examples/*.qmd') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: Cache CondaPkg
+        id: cache-condaPkg
+        uses: actions/cache@v3
+        env:
+          cache-name: cache-condapkg
+        with:
+          path: docs/.CondaPkg
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('docs/CondaPkg.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+      - name: "Documenter rendering (including Quarto)"
+        run: "docs/make.jl --quarto"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.gitignore

@@ -16,3 +16,9 @@ Manifest.toml
 *.DS_Store
 docs/src/contributing.md
 coverage
+docs/.CondaPkg
+docs/src/examples/*_files/*
+docs/src/examples/*.md
+!docs/src/examples/index.md
+examples/*.ipynb
+examples/*_files/*

Project.toml

@@ -1,7 +1,7 @@
 name = "ManoptExamples"
 uuid = "5b8d5e80-5788-45cb-83d6-5e8f1484217d"
 authors = ["Ronny Bergmann <[email protected]>"]
-version = "0.1.1"
+version = "0.1.2"
 
 [deps]
 ManifoldDiff = "af67fdf4-a580-4b9f-bbec-742ef357defd"