Skip to content

Fix docs deploy job by installing mkdocstrings dependencies - #193

Open
amacrutherford with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-deploy-job-failure
Open

Fix docs deploy job by installing mkdocstrings dependencies#193
amacrutherford with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-deploy-job-failure

Conversation

Copilot AI commented Jul 20, 2026

Copy link
Copy Markdown

Summary

The deploy GitHub Actions job failed during mkdocs gh-deploy because mkdocs.yml enables mkdocstrings, but the workflow only installed mkdocs-material. This PR aligns workflow dependencies with the configured MkDocs plugins.

  • Root cause

    • .github/workflows/docs.yml installed only mkdocs-material, while mkdocs.yml requires:
      • mkdocstrings
      • mkdocstrings-python
  • Change

    • Updated the docs deploy install step to include required plugins.
  • Patch

    - run: pip install mkdocs-material
    + run: pip install mkdocs-material mkdocstrings mkdocstrings-python

Checklist

  • Tests added or updated
  • Docs updated (docstrings, README, or tutorial as appropriate)
  • Linting passes (ruff check .)
  • For new environments: IPPO results on 20 seeds included

Copilot AI changed the title [WIP] Fix failing GitHub Actions job deploy Fix docs deploy job by installing mkdocstrings dependencies Jul 20, 2026
Copilot AI requested a review from amacrutherford July 20, 2026 17:36
@amacrutherford
amacrutherford marked this pull request as ready for review July 20, 2026 18:54
@amacrutherford
amacrutherford requested a review from mttga July 20, 2026 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants