Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ext.viewcode following imports does not put correct [docs] links. #6651

Open
Viech opened this issue Aug 16, 2019 · 0 comments
Open

ext.viewcode following imports does not put correct [docs] links. #6651

Viech opened this issue Aug 16, 2019 · 0 comments

Comments

@Viech
Copy link

Viech commented Aug 16, 2019

My top level package imports some objects from subpackages and submodules so that users can access them directly. viewcode_follow_imported_members is made to still find the correct source file in this case. However, the [docs] link that should lead back to the documentation leads to the documentation of the submodule that actually contains the code (which is perfectly fine), but the jump label references the object's alias in the top level package, which is not defined like that on the submodule's documentation page.

To be more clear:

The top level package package has a package.html file that documents package.MyClass. Now MyClass is really defined in the source module package/submodule.py. The [source] link in package.html takes me to _modules/package/submodule.html and the correct code line. But the [docs] link there takes me to package.submodule.html#package.MyClass. The #package.MyClass part is incorrect; such jump label doesn't exist there. The correct jump label would be #package.submodule.MyClass.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants