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.

Sign up for GitHub

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

Jump to bottom

Tables in Documentation not rendering properly #959

Closed
NivekT opened this issue Jan 23, 2023 · 8 comments
Closed

Tables in Documentation not rendering properly #959

NivekT opened this issue Jan 23, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone
0.6.0

Comments

@NivekT
Copy link
Contributor

NivekT commented Jan 23, 2023 •
edited
Loading

📚 The doc issue

Compared to the last release, the tables in the documentation of the main branch is rendering differently. I do not recall any intentional changes to the format of our documentation or generation. We should have a look at this before the next release.

Before (0.5.1):

Screenshot 2023-01-23 at 3 14 36 PM

Current (main):

Screenshot 2023-01-23 at 3 14 45 PM
@NivekT NivekT added good first issue Good for newcomers documentation Improvements or additions to documentation labels Jan 23, 2023
@ejguan
Copy link
Contributor

ejguan commented Jan 23, 2023 •
edited
Loading

The last commit from 0.5.1 is 222877d
So, the culprit has to be a commit between 4ea88d1 and 139d558 under https://github.com/pytorch/data/commits/main/docs

@NivekT
Copy link
Contributor Author

NivekT commented Jan 23, 2023

Also the section expansion works less well now, but unsure if it is related.

Some suspects:

@ejguan ejguan added this to the 0.6.0 milestone Jan 27, 2023
@ejguan ejguan mentioned this issue Jan 31, 2023
Closed
facebook-github-bot pushed a commit that referenced this issue Feb 1, 2023
@ejguan @facebook-github-bot
DataLoader2 tutorial (#980)
1d98097 
Summary:
Fixes #689 #959 #922

### Changes

- Add a section regarding determinism for ReadingService
- Add simple tutorial for DataLoader2
- Fix table rendering for dataloader.html

Example result can be found: https://ejguan.github.io/dataloader2.html

Pull Request resolved: #980

Reviewed By: NivekT

Differential Revision: D42903523

Pulled By: ejguan

fbshipit-source-id: 3d5093312953ac5fb5f247b6a65e161b4842bf8f
@ejguan
Copy link
Contributor

ejguan commented Feb 1, 2023

It's weird that the table is still not rendered correctly.
Nightly: https://pytorch.org/data/main/dataloader2.html
My own replica is rendered correctly though: https://ejguan.github.io/dataloader2.html

@NivekT
Copy link
Contributor Author

NivekT commented Feb 1, 2023

Yea... I think my local copy is rendered properly as well. Unsure what's specific about GHA process that causes this.

@ejguan
Copy link
Contributor

ejguan commented Feb 1, 2023

Let me try to update my sphinx to 6.1.3 aligned with release workflow to see if my local build would change or not.

@ejguan
Copy link
Contributor

ejguan commented Feb 1, 2023

After updated sphinx to 6.1.3, I can now reproduce the rendering problem.

@ejguan
Copy link
Contributor

ejguan commented Feb 1, 2023

Aha, simple solution -> pin sphinx to 5 lke pytorch https://github.com/pytorch/pytorch/blob/207399cf5f68a6370cbacc28fce3fc5d9132c87f/docs/requirements.txt#LL1

@ejguan ejguan mentioned this issue Feb 1, 2023
Closed
@ejguan
Copy link
Contributor

ejguan commented Feb 2, 2023

Confirm the patch works.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
0.6.0
Development

Successfully merging a pull request may close this issue.

Pin sphinx to 5 to render table correctly ejguan/data
2 participants
@NivekT @ejguan