Merge pull request #421 from DHI/quarto

Use Quarto / Quartodoc for documentation

.envrc

@@ -0,0 +1 @@
+source .venv/bin/activate

.github/workflows/docs.yml

@@ -1,13 +1,13 @@
 name: Documentation
 
-on:
+on: 
   push:
-    branches:    
-      - main
+    branches: [ main]
+  pull_request:
+    branches: [ main]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
@@ -18,14 +18,23 @@ jobs:
         python-version: "3.11"
 
     - name: Install modelskill
-      run: pip install .[dev]
-
-    - name: MkDocs
-      run: mkdocs build
+      run: |
+        pip install .[docs]
     
-    - name: Deploy to GitHub Pages
-      uses: peaceiris/actions-gh-pages@v3
+    - name: Build documentation
+      run: |
+        make docs
+
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: docs
+        path: docs/_site/
+
+    - name: Publish to GitHub Pages
+      if: github.ref == 'refs/heads/main'
+      uses: peaceiris/[email protected]
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: site
-
+        publish_dir: docs/_site/
+

.gitignore

@@ -145,4 +145,8 @@ notebooks/sandbox.ipynb
 streamlit_app.py
 notes.md
 
-notebooks/Untitled.ipynb
+notebooks/Untitled.ipynb
+
+docs/_site/
+docs/_extensions/
+docs/api/*.qmd

Makefile

@@ -24,6 +24,22 @@ coverage:
 	pytest --cov-report html --cov=$(LIB) tests/
 
 docs: FORCE
-	mkdocs build
+	set -e; \
+	cd docs; \
+	quartodoc build; \
+	quarto render; \
+	if [ ! -f _site/index.html ]; then \
+        echo "Error: index.html not found. Quarto render failed."; \
+        exit 1; \
+    fi; \
+    cd -
+
+clean:
+	rm -rf .pytest_cache
+	rm -rf .mypy_cache
+	rm -rf .coverage
+	rm -rf dist
+	rm -rf docs/_site
+
 
 FORCE:

docs/.gitignore

@@ -0,0 +1,3 @@
+/.quarto/
+_sidebar.yml
+objects.json

docs/_extensions/fontawesome/_extension.yml

@@ -0,0 +1,7 @@
+title: Font Awesome support
+author: Carlos Scheidegger
+version: 1.1.0
+quarto-required: ">=1.2.269"
+contributes:
+  shortcodes:
+    - fontawesome.lua