Merged
Conversation
Revamp documentation CI: rename workflow, remove scheduled run and ReadTheDocs config, and add caching for Sphinx output. Set USE_CACHE env, change job id to build-doc, make apt-get install use -y, clarify install steps and use a multiline step to uninstall vtk and install vtk-osmesa for headless rendering. Add actions/cache for docs/_build keyed by source and docs files. Update docs/conf.py canonical_url to the GitHub Pages docs URL and delete .readthedocs.yaml to consolidate docs builds under GitHub Actions.
Replace ReadTheDocs documentation links with the GitHub Pages site (https://3mah.github.io/microgen-docs/) in conda.recipe/meta.yaml and pyproject.toml so package metadata points to the hosted docs.
ylgrst
reviewed
Feb 24, 2026
Collaborator
ylgrst
left a comment
ylgrst
left a comment
There was a problem hiding this comment.
Good PR for a useful change.
I did find some readme anchors discrepancies. Even though redirection still works fine, fixing those can prevent broken links in the future
I also have my reservations regarding how docs caching is done but I don't know any good practice about this
Co-authored-by: Yasmin Legerstee <125015797+ylgrst@users.noreply.github.com>
Co-authored-by: Yasmin Legerstee <125015797+ylgrst@users.noreply.github.com>
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
2 participants
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 pull request migrates the documentation hosting from Read the Docs to GitHub Pages and updates the build workflow accordingly. It removes Read the Docs configuration, updates documentation links throughout the project, and improves the GitHub Actions workflow for building and caching documentation. These changes ensure that users and contributors are directed to the new documentation site and that documentation builds are more efficient.
Documentation Hosting Migration
.readthedocs.yamlto discontinue Read the Docs builds and hosting.README.mdto point to the new GitHub Pages site (https://3mah.github.io/microgen-docs/). [1] [2]docs/conf.pyto the new documentation site.Build Workflow Improvements
.github/workflows/build-docs.ymlto reflect the new documentation process, added caching for Sphinx builds, and improved installation steps for dependencies. [1] [2] [3]