Merge pull request #28 from JuliaPhysics/docs-update

Update documentation (housekeeping)

Author: roflmaostc

.github/workflows/DocPreviewCleanup.yml

@@ -0,0 +1,33 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+# Ensure that only one "Doc Preview Cleanup" workflow is force pushing at a time
+concurrency:
+  group: doc-preview-cleanup
+  cancel-in-progress: false
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v4
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+          if [ -d "${preview_dir}" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "${preview_dir}"
+              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:
+          preview_dir: previews/PR${{ github.event.number }}

README.md

@@ -1,4 +1,4 @@
-<a  href="docs/src/assets/RadonKA_logo.png"><img src="docs/logo/logo.png"  width="150"></a>
+<a  href="docs/src/assets/RadonKA_logo.png"><img src="docs/src/assets/logo.png"  width="150"></a>
 
 # WaveOpticsPropagation.jl
 

docs/Project.toml

@@ -1,3 +1,9 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 WaveOpticsPropagation = "c4c7a1f9-3adc-4a73-843a-d378b6c86436"
+
+[compat]
+Documenter = "1"
+
+[sources]
+WaveOpticsPropagation = {path = ".."}