Fix generation of developer documentation for modules which rely on our generated comInterfaces#14016
Merged
seanbudd merged 3 commits intoAug 16, 2022
Conversation
…ur generated comInterfaces
See test results for failed build of commit 65dedd567a |
seanbudd
reviewed
Aug 16, 2022
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
Co-authored-by: Sean Budd <seanbudd123@gmail.com>
seanbudd
approved these changes
Aug 16, 2022
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.
Link to issue number:
None - one of the prerequisites for eventual further work on #12971
Summary of the issue:
When trying to generate developer documentation various modules cannot be imported, and as a result it is impossible to generate any documentation from their docstrings.
In most cases this is caused by the fact that they try to import various com interfaces from our
comInterfacespackage, which cannot work since we set its path in a particular way at runtime.The example error for one of the modules is as follows:
Description of user facing changes
None
Description of development approach
During developer documentation build our com interfaces directory is appended to the
comtypes.gensearch path, to match the behavior at runtime.Testing strategy:
Generated developer documentation - made sure that there are no errors similar to the one shown in the problem description. Checked count of warnings before and after this change - their amount decreased from 532 to 484.
Known issues with pull request:
Since we now generate documentation for some modules which previously weren't importable this PR almost certainly introduces some new warnings. In my opinion any attempt at fixing warnings automatically or making note of which warnings are present and which are new should wait until all our modules can be imported successfully during build of the developer documentation, which is not yet the case.
Change log entries:
None needed
Code Review Checklist: