Added documentation example and refactored example data.

Author: pi-kappa-devel

.github/workflows/deploy-docs.yaml

@@ -29,13 +29,12 @@ jobs:
 
       - name: Install dependencies
         run: |
-          sudo apt-get install -y lftp
+          sudo apt-get install -y lftp quarto
           python -m pip install --upgrade pip
-          python -m pip install build myst-parser setuptools sphinx sphinx-autodoc-typehints
+          python -m pip install build jupyter myst-parser setuptools sphinx sphinx-autodoc-typehints
 
       - name: Build Sphinx docs
         run: |
-          python -m pip install ltn matplotlib numpy pandas rapidfuzz tensorflow
           python -m build
           python -m pip install dist/$(basename `ls -Art dist | tail -n 1` -py3-none-any.whl).tar.gz
           cd docs

README.md

@@ -105,8 +105,6 @@ make html
 
 # Development Notes
 
-## Documentation
-
 ## Logo
 The logo was designed using [Microsoft Designer](https://designer.microsoft.com/) and [GNU Image Manipulation Program (GIMP)](https://www.gimp.org/). The hexagon version of the logo was generated with the R package [hexSticker](https://github.com/GuangchuangYu/hexSticker). It uses the [Philosopher](https://fonts.google.com/specimen/Philosopher) font.
 

docs/Makefile

@@ -17,4 +17,9 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
+	cp "$(SOURCEDIR)/../../LICENSE.txt" "$(SOURCEDIR)/LICENSE.md"
+	cp "$(SOURCEDIR)/../../README.md" "$(SOURCEDIR)/README.md"
+	sed -i 's/LICENSE.txt/LICENSE.md/g' "$(SOURCEDIR)/README.md"
+	sed -i 's/<a.*hex-logo.png.*<\/a>//g' "$(SOURCEDIR)/README.md"
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	quarto render "$(SOURCEDIR)/_static/examples/dl-matching.qmd" --output-dir ../../../build/

docs/source/LICENSE.md

@@ -0,0 +1 @@
+/.quarto/