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

Docs: don't override __module__ #637

Closed
wants to merge 2 commits into from
Closed

Docs: don't override __module__ #637

wants to merge 2 commits into from

Conversation

adamjstewart
Copy link
Collaborator

In Sphinx 3, import aliases would throw off intersphinx:

This was supposedly fixed in Sphinx 4:

I was finally able to upgrade PyTorch and torchvision to use Sphinx 5:

So in theory, we should no longer need to override __module__. Fingers crossed that the doc tests pass and the docs look okay!

@github-actions github-actions bot added datamodules PyTorch Lightning datamodules datasets Geospatial or benchmark datasets losses Geospatial loss functions models Models and pretrained weights samplers Samplers for indexing datasets testing Continuous integration testing trainers PyTorch Lightning trainers transforms Data augmentation transforms labels Jun 29, 2022
@adamjstewart adamjstewart marked this pull request as draft June 29, 2022 19:16
@adamjstewart
Copy link
Collaborator Author

Well, this doesn't work at all. Will open an issue with the Sphinx devs...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
datamodules PyTorch Lightning datamodules datasets Geospatial or benchmark datasets losses Geospatial loss functions models Models and pretrained weights samplers Samplers for indexing datasets testing Continuous integration testing trainers PyTorch Lightning trainers transforms Data augmentation transforms
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant