Fix failing ci docs - #110
Merged
Merged
Conversation
…efore docs are deployed after merge
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.
What and why
Fixes the failing docs deploy and adds a docs check to PRs so failures like this show up before merging.
docs/api/engines.mdstill pointed atPtyLab.Engines.pcPIE, which was deleted in 81d1127. It now points atPtyLab.Engines.mPIE.pcPIE, the deprecated wrapper. The position-correction and engine guides now say to usemPIEwithparams.positionCorrectionSwitch = True.Returns:entries such astuple:were read by griffe as names, not types, which gave 13 warnings that fail--strict. Addedreturns_named_value: falseto the mkdocstrings options inmkdocs.yml.pcPIEwarning was raised on everyimport PtyLab.Engines. It now fires only when apcPIEis created.\mescape inTensorboardMonitor.pyby making the string a raw f-string.docs.ymlinto abuildjob that also runs on PRs and adeployjob that runs only onmain. Pages write permissions now apply only todeploy.pcPIEfrom the feature list and added a Docs status badge that links to the docs site.How it was tested
uv run --extra docs mkdocs build --strictpasses locally with no warnings.import PtyLab.Enginesno longer raises the deprecation warning. CreatingEngines.pcPIE(...)raises it, pointing at the caller's line.Notes
Docs / buildas a required status check onmainso a failing docs build blocks merges.example_scripts/exampleReconstruction_pcPIE.pyand the lateral position correction tutorial notebook still useEngines.pcPIE. They still work but now show the deprecation warning; they can be moved tomPIEin a follow-up.