Update Python frozen docs#2168
Merged
Merged
Conversation
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Signed-off-by: Rémi Achard <remiachard@gmail.com>
Collaborator
|
This is awesome Remi! Cuneyt was looking at it a little but didn't come up with anything and he just left for vacation for the next six weeks, so your fix is good timing. |
doug-walker
approved these changes
Jun 14, 2025
Collaborator
doug-walker
left a comment
doug-walker
left a comment
There was a problem hiding this comment.
LGTM! Looks like this fixed the DOCS=ON CI runs.
zachlewis
approved these changes
Jun 17, 2025
Collaborator
zachlewis
left a comment
zachlewis
left a comment
There was a problem hiding this comment.
Well done -- thanks Remi!
michaelHADSK
pushed a commit
to autodesk-forks/OpenColorIO
that referenced
this pull request
Jul 24, 2025
* Remove excluded member Signed-off-by: Rémi Achard <remiachard@gmail.com> * Fix import errors Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove duplicated members Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove unused file Signed-off-by: Rémi Achard <remiachard@gmail.com> * Avoid package name duplication in Python documentation type hints Signed-off-by: Rémi Achard <remiachard@gmail.com> * Build frozen docs Signed-off-by: Rémi Achard <remiachard@gmail.com> --------- Signed-off-by: Rémi Achard <remiachard@gmail.com>
michaelHADSK
pushed a commit
to autodesk-forks/OpenColorIO
that referenced
this pull request
Jul 24, 2025
* Remove excluded member Signed-off-by: Rémi Achard <remiachard@gmail.com> * Fix import errors Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove duplicated members Signed-off-by: Rémi Achard <remiachard@gmail.com> * Remove unused file Signed-off-by: Rémi Achard <remiachard@gmail.com> * Avoid package name duplication in Python documentation type hints Signed-off-by: Rémi Achard <remiachard@gmail.com> * Build frozen docs Signed-off-by: Rémi Achard <remiachard@gmail.com> --------- Signed-off-by: Rémi Achard <remiachard@gmail.com> Signed-off-by: Michael Horsch <michael.horsch@autodesk.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
3 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 is an attempt to fix the frozen doc errors in CI. I tried to fix a few warnings in the doc generation (there are still a lot, eg. undefined labels and cross references), and added a simple hack to remove the
PyOpenColorIO.PyOpenColorIOduplication in the documentation generated type hints. I tried to use some autodoc settings to change these hints but no success, and it is not probably an ideal solution either. The same duplication might still come up again if we get rid of the frozen doc workflow, maybe we will need to rename the pybind11 module to something likeCore(PyOpenColorIO.Core) or something else if there are no other ways?There is an issue in the updated frozen docs where some of Config:: prefixes in the ref links disappears.
I'm not sure if someone else is looking at this issue and have come up with a better solution, in which case this can be ignored.