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

Use stable docs #539

Merged
merged 1 commit into from
May 19, 2022
Merged

Use stable docs #539

merged 1 commit into from
May 19, 2022

Conversation

ashnair1
Copy link
Collaborator

Fixes #538

@github-actions github-actions bot added the documentation Improvements or additions to documentation label May 19, 2022
isaaccorley
isaaccorley previously approved these changes May 19, 2022
adamjstewart
adamjstewart previously approved these changes May 19, 2022
Copy link
Collaborator

@adamjstewart adamjstewart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took me a while to understand this problem. So the issue is that our docs point to "latest", aka the master branch, but pip installs "stable", aka the latest release. And those two have different file hierarchies due to Lightning-AI/pytorch-lightning#12740, hence the inability to find the class documentation. Makes sense, and good catch!

Should we also convert all other "latest" to "stable"? Might help to prevent this kind of problem in the future.

@ashnair1
Copy link
Collaborator Author

Switching to stable is a good idea. Pushing now

@ashnair1 ashnair1 changed the title Use stable lightning docs Use stable docs May 19, 2022
@adamjstewart adamjstewart enabled auto-merge (squash) May 19, 2022 16:45
@adamjstewart adamjstewart merged commit a755bb6 into microsoft:main May 19, 2022
@ashnair1 ashnair1 deleted the pl-docfix branch May 19, 2022 16:48
remtav pushed a commit to remtav/torchgeo that referenced this pull request May 26, 2022
yichiac pushed a commit to yichiac/torchgeo that referenced this pull request Apr 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs failing due to pytorch-lightning deprecation
3 participants