Merge pull request #426 from AutoResearch/docs/add-site-url

docs: add site url (fixes links)

docs/hooks.py

@@ -0,0 +1,12 @@
+import os
+from urllib.parse import quote
+
+
+def basename(path):
+    return os.path.basename(path)
+
+
+def on_env(env, config, files, **kwargs):
+    env.filters["basename"] = basename
+    env.filters["quote"] = quote
+    return env

mkdocs.yml

@@ -1,11 +1,12 @@
 # yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
 
 site_name: Automated Research Assistant
-repo_url: 'https://github.com/autoresearch/autora'
+repo_url: 'https://github.com/autoresearch/autora/'
+site_url: 'https://autoresearch.github.io/autora/'
 edit_uri: 'blob/main/docs/'
 
 extra:
-  colab_base_url: 'https://colab.research.google.com/github/AutoResearch/autora/blob/gh-pages'
+  colab_base_url: 'https://colab.research.google.com/github/AutoResearch/autora/blob/gh-pages/'
 
 theme:
   name: material
@@ -26,8 +27,6 @@ theme:
         name: Switch to light mode
   custom_dir: mkdocs/overrides
   features:
-    - content.action.edit
-    - content.action.view
     - navigation.indexes
 
 plugins:
@@ -44,6 +43,9 @@ plugins:
     execute: false
     ignore_h1_titles: true
   search: {}
+  mkdocs-simple-hooks:
+    hooks:
+      on_env: "docs.hooks:on_env"
 
 markdown_extensions:
   admonition: {}

mkdocs/overrides/main.html

@@ -2,10 +2,11 @@
 
 {% block content %}
 {% if page.nb_url %}
-    <a href="{{ page.nb_url }}" title="Download Notebook" class="md-content__button md-icon">
+    <a href="{{ page.canonical_url }}{{ page.file.src_uri | basename | quote }}" title="Download Notebook"
+       class="md-content__button md-icon">
         {% include ".icons/material/download.svg" %}
     </a>
-    <a href="{{ config.extra.colab_base_url }}{{ page.nb_url }}"
+    <a href="{{ config.extra.colab_base_url }}{{ page.url }}{{ page.file.src_uri | basename | quote }}"
        title="Open Notebook in Google Colab" class="md-content__button md-icon">
         {% include ".icons/material/play-circle-outline.svg" %}
     </a>

pyproject.toml

@@ -94,6 +94,7 @@ experiment-runner-recruitment-manager-prolific = [
 
 docs = [
   "autora-core[docs]",
+  "mkdocs-simple-hooks",
 ]
 
 test = [