Update doc builds to template

.github/workflows/docs.yaml

@@ -2,10 +2,8 @@ name: Publish Documentation
 
 on:
   push:
-    branches:
-      - main
-    tags:
-      - '*'
+    branches: ["main"]
+    tags: ["*"]
 
 jobs:
   deploy-docs:
@@ -43,11 +41,12 @@ jobs:
         git config --global --add safe.directory "$PWD"
         git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
 
+        git pull origin gh-pages
         git fetch --all --prune
 
         make env
 
         sed -i 's/# extensions/extensions/' mkdocs.yml
+        make docs-insiders INSIDER_DOCS_TOKEN="${INSIDER_DOCS_TOKEN}"
 
-        make docs-insiders INSIDER_DOCS_TOKEN="${INSIDER_DOCS_TOKEN}"        
         make docs-deploy VERSION="$VERSION"

mkdocs.yml

@@ -5,14 +5,18 @@ repo_url: "https://github.com/SimonBoothroyd/smee"
 repo_name: "SimonBoothroyd/smee"
 site_dir: "site"
 watch: [mkdocs.yml, README.md, smee/, docs]
-copyright: Copyright © 2023 Simon Boothroyd
+copyright: Copyright © 2024 Simon Boothroyd
 edit_uri: edit/main/docs/
 
 validation:
   omitted_files: warn
   absolute_links: warn
   unrecognized_links: warn
 
+extra:
+  version:
+    provider: mike
+
 nav:
 - Home:
   - Overview: index.md
@@ -43,10 +47,6 @@ theme:
   - search.suggest
   - toc.follow
   palette:
-  - media: "(prefers-color-scheme)"
-    toggle:
-      icon: material/brightness-auto
-      name: Switch to light mode
   - media: "(prefers-color-scheme: light)"
     scheme: default
     primary: teal
@@ -60,10 +60,11 @@ theme:
     accent: lime
     toggle:
       icon: material/weather-night
-      name: Switch to system preference
+      name: Switch to light mode
 
 markdown_extensions:
 - attr_list
+- md_in_html
 - def_list
 - admonition
 - footnotes
@@ -98,14 +99,15 @@ plugins:
     handlers:
       python:
         paths: [smee/]
+        import:
+         - http://docs.openmm.org/latest/api-python/objects.inv
         options:
           # extensions: [ griffe_pydantic ]
           docstring_options:
             ignore_init_summary: true
             returns_multiple_items: false
             returns_named_value: false
           docstring_section_style: list
-          filters: ["!^_"]
           heading_level: 1
           inherited_members: true
           merge_init_into_class: true
@@ -115,6 +117,7 @@ plugins:
           show_signature_annotations: true
           show_symbol_type_heading: true
           show_symbol_type_toc: true
+          show_if_no_docstring: false
           signature_crossrefs: true
           summary: true
           members_order: source