Viewcode: Fix issue with import paths that differ from the directory structure #13195
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 PR fixes an issue that occurs when, the module import path used by users does not match the directory / file structure. In this case, the
import_lib
'simport_module
function cannot find the correct path.This issue results in code docs missing the associated viewcode link when the extension is used.
My simple solution utilizes
importlib
's__import__
function to find the actual directory module path to the import.Feature / Bugfix
Purpose
If the module import path used by users does not match the directory / file structure,
import_lib
'simport_module
function cannot find it.Below is a basic example of where this failure occurs:
Using the above directory / file structure, users import
module1
via:Sphinx is generally able to handle this sort of structure, except for the viewcode extension that uses the
get_full_modname
function from here: https://github.com/sphinx-doc/sphinx/blob/5.x/sphinx/util/__init__.pyThat function specifically causes an error with the above example when
importlib
'simport_module
is run:The exact path to the module however has no error:
Relates
A remake of this PR:
#10766
CC: @AA-Turner