Automate mkdocs deployment#1340
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
SylviaWhittle
approved these changes
Apr 15, 2026
Collaborator
SylviaWhittle
left a comment
There was a problem hiding this comment.
🤞 that this all works - it will be great. :)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the existing workflow for auto-deploying the Topostats docs. It:
docsdependencies to usemkdocsand the required pluginssphinxworkflowmkdocsandmiketo produce versioned docsThe new workflow does the following:
devversion of the docs will be updated. Older snapshots (e.g. 2.4.0) will be left as they are.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.