Skip to content

Converted .rst files to MyST .md files #155107

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

Closed
wants to merge 6 commits into from

Conversation

FORTFANOP
Copy link

@FORTFANOP FORTFANOP commented Jun 4, 2025

Copy link

pytorch-bot bot commented Jun 4, 2025

🔗 Helpful Links

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

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

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

@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 4, 2025
@FORTFANOP
Copy link
Author

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label Jun 4, 2025
zxiiro
zxiiro previously approved these changes Jun 4, 2025
@svekars
Copy link
Contributor

svekars commented Jun 4, 2025

Please use git mv filename.rst filename.md as per the instructions in the issue to convert instead of deleting the .rst file and creating an .md file.

@zxiiro zxiiro dismissed their stale review June 4, 2025 16:31

I'm not a reviewer for the docathon.

@@ -0,0 +1,25 @@
---
Copy link
Contributor

@svekars svekars Jun 4, 2025

Choose a reason for hiding this comment

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

I think this file might have been improperly converted. If I run from your branch/fork:

git log --follow --oneline -- docs/source/mobile_optimizer.md

I only get one item in the git log:

71c7477c84f convert mobile_optimizer.rst to mobile_optimizer.md

But if I run from main for the .rst file I get:

0d193a0adf0 Add ExecuTorch warning to mobile_optimizer (#134697)
da43584bef3 [Reland] Clean Up MobileOptimizerType Rewrite Flags Public API and Documentation (#92081)
4f91b8e0ee8 Fix typo under docs directory  (#91871)
3aeb7127b44 Revert "Clean Up MobileOptimizerType Rewrite Flags Public API and Documentation (#91600)"
370df963e06 Clean Up MobileOptimizerType Rewrite Flags Public API and Documentation (#91600)
df1cc0ef473 [Vulkan] Add Vulkan Rewrite to Transfer Inputs and Outputs to Vulkan and CPU Backends Respectively (#87432)
b3387139b42 Mod lists to neutral+descriptive terms in caffe2/docs (#49803)
79b8328aaf5 optimize_for_mobile: bring packed params to root module (#42740)
04320a47d76 Add optimizer_for_mobile doc into python api root doc (#41211)

We want to preserve history for this file which I think we achieve (more or less) with git mv or any other way you want to propose. All other files I checked in this PR seem to have preserved their git log.

Copy link
Author

Choose a reason for hiding this comment

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

That's weird, I used the same method for all files, ie, git mv
On my local repo too, running the command you mentioned doesn't work for the .md files but they do for the .rst files. Not sure why this is so, and looks like the same issue is happening with others as well

Copy link
Author

Choose a reason for hiding this comment

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

Kindly forgive if its trivial, I'm new to open source

Copy link
Collaborator

Choose a reason for hiding this comment

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

Its due to how Git works. If too many lines in a file is changed Git won't find similarity between 2 files so doesn't show that they were renamed. Git doesn't actually store the history of changes in its database but rather the state of the entire workspace. I tried to explain it here hopefully it helps explain but this is expected.

#155120 (comment)

Co-authored-by: Svetlana Karslioglu <svekars@meta.com>
@FORTFANOP FORTFANOP closed this Jun 5, 2025
@FORTFANOP FORTFANOP deleted the rst-to-md branch June 5, 2025 04:19
@FORTFANOP FORTFANOP restored the rst-to-md branch June 5, 2025 04:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docathon-h1-2025 medium Label for medium docathon tasks module: docs Related to our documentation, both in docs/ and docblocks open source 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
Development

Successfully merging this pull request may close these issues.

Convert to markdown: mobile_optimizer.rst, model_zoo.rst, module_tracker.rst, monitor.rst, mps_environment_variables.rst
4 participants