Fix errors when deploying docs#1179
Conversation
There was a problem hiding this comment.
Pull request overview
This PR addresses failures in the documentation deployment workflow by ensuring the docs build imports the repository’s local source tree and by aligning the docs CI environment’s Python pinning with the conda_install_reqs.sh script expectations.
Changes:
- Update
docs/conf.pyto prepend the repository root tosys.path(and remove the old path tweak). - Update
deploy_docs.ymlto setCONDA_PYand switch the Miniconda Python version to 3.12, with the OPS install step placed after doc-tool installation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
docs/conf.py |
Ensures Sphinx imports the local repo code before any installed package version. |
.github/workflows/deploy_docs.yml |
Pins Python via CONDA_PY/Miniconda to prevent requirements install failures during docs deploy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| env: | ||
| CONDA_PY: "3.12" | ||
| steps: | ||
| - uses: actions/checkout@v2 |
There was a problem hiding this comment.
PR description references a docs_deploy.yml workflow, but the repository workflow file appears to be named deploy_docs.yml. Please update the PR description (or rename the workflow file if that was the intent) so it's clear which workflow this change is fixing.
There was a problem hiding this comment.
Edited and fixed. But seriously, that's your comment, Copilot? 🤨
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1179 +/- ##
=======================================
Coverage 81.29% 81.29%
=======================================
Files 147 147
Lines 15810 15810
=======================================
Hits 12852 12852
Misses 2958 2958 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
This is ready for review and comment. Without review, I will merge this after at least 24 hours, no sooner than Mon 02 Mar 04:00 GMT (Sun 01 Mar 22:00 my local). |
sroet
left a comment
There was a problem hiding this comment.
Small nitpick, but looks great otherwise
The
deploy_docs.ymlworkflow was failing on merges. This PR will work on fixing it.