Merge pull request #655 from DHI/quarto

Change documentation from Sphinx to Quartodoc / Quarto
DHI · Feb 23, 2024 · b556f3c · b556f3c
2 parents ea727b2 + 7f89044
commit b556f3c
Show file tree

Hide file tree

Showing 87 changed files with 10,558 additions and 1,324 deletions.
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
@@ -20,13 +20,12 @@ jobs:
       run: |
         pip install .[dev]
     
-    - name: Sphinx Build
+    - name: Build documentation
       run: |
-        cd docs
-        make html
+        make docs
 
     - name: Upload documentation
       uses: actions/upload-artifact@v2
       with:
         name: html
-        path: docs/_build/html
+        path: docs/_site/
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -23,13 +23,12 @@ jobs:
       run: |
         pip install .[dev]
     
-    - name: Sphinx Build
+    - name: Build documentation
       run: |
-        cd docs
-        make html
+        make docs
 
     - name: Publish to GitHub Pages
       uses: peaceiris/[email protected]
       with:
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/_build/html
+        publish_dir: docs/_site/
diff --git a/.gitignore b/.gitignore
@@ -24,7 +24,11 @@ cov_html
 cov_annotate
 htmlcov
 
-docs/_build
+docs/_site
+
+# generated by quartodoc
+docs/api/
+
 \tmp
 .venv/
 

diff --git a/Makefile b/Makefile
@@ -28,7 +28,10 @@ perftest:
 	pytest tests/performance/ --durations=0
 
 docs: FORCE
-	cd docs; make html ;cd -
+	cd docs && quarto add --no-prompt .
+	cd docs && quartodoc build
+	cd docs && quartodoc interlinks
+	quarto render docs
 
 FORCE:
 

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+/.quarto/
diff --git a/docs/MIKE-IO-Icon-Pos-RGB.png b/docs/MIKE-IO-Icon-Pos-RGB.png
diff --git a/docs/MIKE-IO-Logo-Pos-RGB.svg b/docs/MIKE-IO-Logo-Pos-RGB.svg
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/_extensions/fontawesome/_extension.yml b/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