Skip to content

Fix #155022 rst to markdown conversion #155540

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
Closed
wants to merge 2 commits into from
Closed

Fix #155022 rst to markdown conversion #155540

wants to merge 2 commits into from

Conversation

j-silv
Copy link
Contributor

@j-silv j-silv commented Jun 10, 2025 •
edited by AlannaBurke
Loading

Used rst2myst tool

Fixes #155022

Docs comparison (check out the 'new' whenever docs build)

  1. func.ux_limitations (old vs. new)
  2. func.whirlwind_tour (old vs. new)
  3. future_mod (old vs. new)
  4. futures (old vs. new)
  5. fx.experimental (old vs. new)

cc @svekars @sekyondaMeta @AlannaBurke

@pytorch-bot PyTorch Bot
Copy link

pytorch-bot bot commented Jun 10, 2025 •
edited
Loading

🔗 Helpful Links

🧪 See artifacts and rendered test results at hud.pytorch.org/pr/155540

Note: Links to docs will display an error until the docs builds have been completed.

⏳ 17 Pending, 1 Unrelated Failure

As of commit c2ed40f with merge base 4a954fc (image):

FLAKY - The following job failed but was likely due to flakiness present on trunk:

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@j-silv
Copy link
Contributor Author

j-silv commented Jun 10, 2025

@pytorchbot label "topic: docs"

@github-actions github-actions bot added docathon-h1-2025 medium Label for medium docathon tasks 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 labels Jun 10, 2025
@pytorch-bot pytorch-bot bot added the topic: docs topic category label Jun 10, 2025
@j-silv
Copy link
Contributor Author

j-silv commented Jun 10, 2025

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Jun 10, 2025
@svekars svekars requested a review from sekyondaMeta June 10, 2025 16:00
@AlannaBurke AlannaBurke self-requested a review June 10, 2025 19:55
@svekars
Copy link
Contributor

svekars commented Jun 10, 2025

These pages have Created On changed to Jun 09, 2025, this needs to be fixed:
https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.ux_limitations.html
https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.whirlwind_tour.html
https://docs-preview.pytorch.org/pytorch/pytorch/155540/futures.html

@j-silv
Copy link
Contributor Author

j-silv commented Jun 11, 2025

These pages have Created On changed to Jun 09, 2025, this needs to be fixed: https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.ux_limitations.html https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.whirlwind_tour.html https://docs-preview.pytorch.org/pytorch/pytorch/155540/futures.html

How exactly can we fix this? I did use git mv but the changes between the .rst and .md files were too large and thus Git detected it as a delete/new file operation instead of a rename/modify. This is happening here.

I don't see how you can get Git to think it is the same file unless you modify the file with multiple commits... and since git thinks it's a new file, the "Created On" time which is extracted from git log will not track the original file.

@jafraustro
Copy link
Contributor

These pages have Created On changed to Jun 09, 2025, this needs to be fixed: https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.ux_limitations.html https://docs-preview.pytorch.org/pytorch/pytorch/155540/func.whirlwind_tour.html https://docs-preview.pytorch.org/pytorch/pytorch/155540/futures.html

How exactly can we fix this? I did use git mv but the changes between the .rst and .md files were too large and thus Git detected it as a delete/new file operation instead of a rename/modify. This is happening here.

I don't see how you can get Git to think it is the same file unless you modify the file with multiple commits... and since git thinks it's a new file, the "Created On" time which is extracted from git log will not track the original file.

Try splitting the commits. First, make one commit for the git mv (file move/rename). Then, make a separate commit to update the file format. This approach works well for me.

@j-silv
Fix pytorch#155022 rst to markdown conversion
c405b0a 
Only git mv func.ux_limitations, func.whirlwind_tour, and futures
because after rst-markdown conversion, git thinks we deleted and added
new files. The conversion changes will come in a second commit/PR.
@j-silv j-silv force-pushed the 155022-rst-to-markdown branch from 3314e47 to c405b0a Compare June 11, 2025 23:01
@j-silv
Fix pytorch#155022 with previously renamed rst files
c2ed40f 
Split into 2 commits (this is the second one) so that we maintain
the git log of these files.
@j-silv
Copy link
Contributor Author

j-silv commented Jun 11, 2025

@pytorchbot drci

@svekars
Copy link
Contributor

svekars commented Jun 12, 2025

@pytorchbot merge -f "Docs only change. Doc signal is green"

@pytorchmergebot
Copy link
Collaborator

Merge started

Your change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Please use -f as last resort and instead consider -i/--ignore-current to continue the merge ignoring current failures. This will allow currently pending tests to finish and report signal before the merge.

Learn more about merging in the wiki.

Questions? Feedback? Please reach out to the PyTorch DevX Team

Advanced Debugging
Check the merge workflow status
here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlannaBurke AlannaBurke AlannaBurke approved these changes

@svekars svekars svekars approved these changes

@sekyondaMeta sekyondaMeta Awaiting requested review from sekyondaMeta

Assignees
No one assigned
Labels
docathon-h1-2025 medium Label for medium docathon tasks Merged module: docs Related to our documentation, both in docs/ and docblocks open source topic: docs topic category topic: not user facing topic category triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Convert to markdown: func.ux_limitations.rst, func.whirlwind_tour.rst, future_mod.rst, futures.rst, fx.experimental.rst
6 participants
@j-silv @svekars @jafraustro @pytorchmergebot @AlannaBurke @pytorchbot