Skip to content

Automate mkdocs deployment#1340

Merged
ubdbra001 merged 3 commits into
AFM-SPM:mainfrom
ubdbra001:github-workflow-additions
Apr 15, 2026
Merged

Automate mkdocs deployment#1340
ubdbra001 merged 3 commits into
AFM-SPM:mainfrom
ubdbra001:github-workflow-additions

Conversation

@ubdbra001
Copy link
Copy Markdown
Collaborator

This PR updates the existing workflow for auto-deploying the Topostats docs. It:

  • Updates the docs dependencies to use mkdocs and the required plugins
  • Removes the old sphinx workflow
  • Adds a new workflow using mkdocs and mike to produce versioned docs

The new workflow does the following:

  • On a merged PR or a manual dispatch the dev version of the docs will be updated. Older snapshots (e.g. 2.4.0) will be left as they are.
  • When a new release is created (not a pre-release) the workflow will take a snapshot of the docs, add it to the list of versions available on the site using the version ID used in the release, and move the '(latest)` suffix to the most recent release of the docs.

I have tested this on my own branch and it does appear to be working correctly. I think that does everything discussed previously, but let me know if there is anything else required.

@ubdbra001 ubdbra001 self-assigned this Apr 15, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.98%. Comparing base (4e88c86) to head (82ebe8f).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1340   +/-   ##
=======================================
  Coverage   87.98%   87.98%           
=======================================
  Files          31       31           
  Lines        6026     6027    +1     
=======================================
+ Hits         5302     5303    +1     
  Misses        724      724           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Collaborator

@SylviaWhittle SylviaWhittle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤞 that this all works - it will be great. :)

@ubdbra001 ubdbra001 merged commit 3ee95cd into AFM-SPM:main Apr 15, 2026
6 of 9 checks passed
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.

mkdocs build is missing GitHub Workflow and older docs versions missing

2 participants