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

Anchor links for documentation are gone in 1.8.0 docs #54683

Closed
zou3519 opened this issue Mar 25, 2021 · 10 comments
Closed

Anchor links for documentation are gone in 1.8.0 docs #54683

zou3519 opened this issue Mar 25, 2021 · 10 comments
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module

Comments

@zou3519
Copy link
Contributor

zou3519 commented Mar 25, 2021

📚 Documentation

In 1.7.1 (notice the anchor on right):
image

In 1.8.0, the anchor doesn't show up anymore:
https://pytorch.org/docs/stable/autograd.html

cc @brianjo @mruberry

@ailzhang ailzhang added the module: docs Related to our documentation, both in docs/ and docblocks label Mar 26, 2021
@brianjo
Copy link
Contributor

brianjo commented Mar 26, 2021

I'll fix this. I just need to copy a couple of js files in.

@ezyang ezyang added the triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module label Mar 26, 2021
@brianjo
Copy link
Contributor

brianjo commented Mar 26, 2021

This should be working for stable/1.8.1 now.

@brianjo brianjo closed this as completed Mar 26, 2021
@zou3519 zou3519 reopened this Mar 29, 2021
@zou3519
Copy link
Contributor Author

zou3519 commented Mar 29, 2021

Discussed offline: the problem reoccurred so re-opening this issue. cc @mattip as well.

@brianjo
Copy link
Contributor

brianjo commented Mar 29, 2021

I think the problem is that the vendor folder is missing from https://github.com/pytorch/pytorch.github.io/tree/site/docs/1.8.1/_static/js. (So they're not available in the stable folder on our master (gh-pages) branch. The missing folder can be found in the master folder: https://github.com/pytorch/pytorch.github.io/tree/site/docs/master/_static/js/vendor.

(I think the build is overwriting my gh-pages fix. I'll ty adding it to 1.8.1 on site.)

I tried a new fix here:
pytorch/pytorch.github.io#643

If that works in preview I'll merge it.

Edit: Fix seems to work:

https://6061e873ee736f0007f3a2d9--pytorch-dot-org-preview.netlify.app/docs/stable/autograd.html

@zou3519
Copy link
Contributor Author

zou3519 commented Mar 29, 2021

They're back! https://pytorch.org/docs/stable/autograd.html#torch.autograd.backward . Thanks @brianjo.

Should we leave this issue open? I think there is still a question of why the vendor folder doesn't get copied as a part of the docs build process that we should work out so we don't have to remember to copy it every time we do a release

@mattip
Copy link
Collaborator

mattip commented Mar 30, 2021

The files do not exist in this repo. See PR #54961, which add them here. Should they be part of the theme instead?

Edit: The files are part of the theme

@brianjo
Copy link
Contributor

brianjo commented Mar 30, 2021

Could it be that jekyll is causing problems? mpetrovich/stylemark#65. Do we need to add a .nojekyll to every new documentation release?

@brianjo
Copy link
Contributor

brianjo commented Mar 30, 2021

The files do not exist in this repo. See PR #54961, which add them here. Should they be part of the theme instead?

They appear to be there: https://github.com/pytorch/pytorch_sphinx_theme/tree/master/pytorch_sphinx_theme/static/js/vendor

@brianjo
Copy link
Contributor

brianjo commented Mar 30, 2021

Just created pytorch/pytorch.github.io#649 to try it out.

@brianjo
Copy link
Contributor

brianjo commented Mar 31, 2021

Just created pytorch/pytorch.github.io#649 to try it out.

Just checked https://pytorch.org/docs/stable/autograd.html#torch.autograd.backward and the fix seems to be working. I'll close this for now. Please reopen if we have issues again. Thank you Richard! @zou3519

@brianjo brianjo closed this as completed Mar 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
module: docs Related to our documentation, both in docs/ and docblocks triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants