chore: some docs building stuff

Author: okunator

docs/javascripts/katex.js

@@ -0,0 +1,10 @@
+document$.subscribe(({ body }) => {
+    renderMathInElement(body, {
+      delimiters: [
+        { left: "$$",  right: "$$",  display: true },
+        { left: "$",   right: "$",   display: false },
+        { left: "\\(", right: "\\)", display: false },
+        { left: "\\[", right: "\\]", display: true }
+      ],
+    })
+  })

mkdocs.yml

@@ -1,6 +1,7 @@
 site_name: histolytics docs
 site_description: Documentation for Histolytics, a library for panoptic histopathology WSI analysis
 site_author: Oskari Lehtonen
+site_url: https://HautaniemiLab.github.io/histolytics/
 repo_url: https://github.com/HautaniemiLab/histolytics
 repo_name: histolytics
 
@@ -22,12 +23,12 @@ theme:
     - navigation.indexes
     - navigation.instant
     - navigation.tracking
-    - navigation.expand
     - navigation.indexes
 
-
 plugins:
   - search
+  - social
+  - autorefs
   - mkdocstrings:
       default_handler: python
       handlers:
@@ -36,19 +37,51 @@ plugins:
             docstring_style: google
           rendering:
             show_source: true
+  - mkdocs-jupyter:
+      include: ["*.ipynb"]
 
 markdown_extensions:
   - pymdownx.highlight:
       anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.arithmatex:
+      generic: true
+  - codehilite
+  - markdown.extensions.def_list
   - pymdownx.inlinehilite
   - pymdownx.snippets
+  - pymdownx.emoji
   - pymdownx.superfences
-  - admonition
+  - pymdownx.magiclink
+  - pymdownx.keys
   - pymdownx.details
+  - admonition
+  - attr_list
+  - tables
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - admonition
+
   - pymdownx.tabbed:
       alternate_style: true
   - tables
   - footnotes
+  - toc:
+        permalink: true
+
+extra_javascript:
+  - javascripts/katex.js
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
+
+extra_css:
+  - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css
+
+
 
 nav:
   - Home: index.md

pyproject.toml

@@ -26,7 +26,7 @@ docs = [
     "mkdocs>=1.6.1",
     "mkdocs-gen-files>=0.5.0",
     "mkdocs-jupyter>=0.25.1",
-    "mkdocs-material>=9.6.12",
+    "mkdocs-material[imaging]>=9.6.12",
     "mkdocstrings>=0.29.1",
     "mkdocstrings-python>=1.16.10",
     "pymdown-extensions>=10.15",