Skip to content

[Docathon] Convert tensor_view.rst to MyST Markdown#182620

Closed
praneethhere wants to merge 2 commits into
pytorch:mainfrom
praneethhere:docathon-convert-tensor-view
Closed

[Docathon] Convert tensor_view.rst to MyST Markdown#182620
praneethhere wants to merge 2 commits into
pytorch:mainfrom
praneethhere:docathon-convert-tensor-view

Conversation

@praneethhere

@praneethhere praneethhere commented May 6, 2026

Copy link
Copy Markdown
Contributor

Fixes #182509

Converts docs/source/tensor_view.rst to MyST Markdown as part of the PyTorch Docathon rST-to-MyST migration

Changes:

  • Renamed tensor_view.rst to tensor_view.md using git mv
  • Kept the pure rename as a separate first commit to preserve history
  • Converted the page anchor, heading, code blocks, note block, links, and Sphinx roles to MyST Markdown syntax
  • Kept the rendered documentation content equivalent to the original page

Validation:

  • lintrunner -m main

Note:
The first commit is a pure rename-only commit showing docs/source/tensor_view.rst renamed to docs/source/tensor_view.md without content changes

cc @svekars @sekyondaMeta @AlannaBurke

@pytorch-bot

pytorch-bot Bot commented May 6, 2026

Copy link
Copy Markdown

🔗 Helpful Links

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

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

❌ 1 New Failure

As of commit 7a45220 with merge base dcf14ce (image):

NEW FAILURE - The following job has failed:

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

@pytorch-bot

pytorch-bot Bot commented May 6, 2026

Copy link
Copy Markdown

This PR needs a release notes: label

If your changes are user facing and intended to be a part of release notes, please use a label starting with release notes:.

If not, please add the topic: not user facing label.

To add a label, you can comment to pytorchbot, for example
@pytorchbot label "topic: not user facing"

For more information, see
https://github.com/pytorch/pytorch/wiki/PyTorch-AutoLabel-Bot#why-categorize-for-release-notes-and-how-does-it-work.

@linux-foundation-easycla

linux-foundation-easycla Bot commented May 6, 2026

Copy link
Copy Markdown

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: praneethhere / name: Praneeth Kodumagulla (7a45220, 867d73e)

@github-actions github-actions Bot added docathon-2026 PyTorch Docathon H1 2026 easy label for easy docathon tasks module: docs Related to our documentation, both in docs/ and docblocks rst-to-md triaged This issue has been looked at a team member, and triaged and prioritized into an appropriate module labels May 6, 2026
@praneethhere

Copy link
Copy Markdown
Contributor Author

@pytorchbot label "topic: not user facing"

@pytorch-bot pytorch-bot Bot added the topic: not user facing topic category label May 6, 2026
@svekars

svekars commented May 6, 2026

Copy link
Copy Markdown
Contributor

@claude

@claude

claude Bot commented May 6, 2026

Copy link
Copy Markdown

Claude finished @svekars's task in 1m 25s —— View job


Reviewing PR #182620

  • Gather context and read changed files
  • Review the MyST Markdown conversion for correctness
  • Check for any issues or improvements
  • Post review feedback

Review Summary

This is a clean and correct RST-to-MyST conversion. The PR properly:

  1. Commit structure: Separates the rename (commit 1) from the content conversion (commit 2) to preserve git history — good practice.
  2. Cross-references: All :meth: and :attr: roles are correctly converted to {meth} and {attr} MyST syntax.
  3. Directives: The .. note:: directive is properly converted to ```{note} fenced block syntax.
  4. Links: External links are converted from RST `text <url>`_ to Markdown [text](url).
  5. Code blocks: The RST :: blocks are converted to ```python fenced code blocks.
  6. Page anchor: The .. _tensor-view-doc: label is correctly converted to (tensor-view-doc)= MyST target syntax.
  7. Toctree compatibility: The pytorch-api.md toctree references tensor_view without extension, so it resolves correctly regardless of .rst or .md suffix.

No issues found. The conversion is faithful to the original content and follows MyST Markdown conventions correctly. LGTM! ✓


Comment thread docs/source/redirects.py Outdated
@@ -159,4 +159,5 @@
"user_guide/torch_compiler/compile/"
"programming_model.where_to_apply_compile.html"
),
"tensor_view": "tensor_view.html",

@svekars svekars May 7, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this is not needed - ignore the link check failure

Suggested change
"tensor_view": "tensor_view.html",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks, removed redirect entry and pushed the update

@praneethhere praneethhere force-pushed the docathon-convert-tensor-view branch from d742e89 to 7a45220 Compare May 7, 2026 17:07
@svekars

svekars commented May 7, 2026

Copy link
Copy Markdown
Contributor

@pytorchbot merge -f "Docs only change"

@pytorchmergebot

Copy link
Copy Markdown
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

Alokksinha00 pushed a commit to Alokksinha00/pytorch that referenced this pull request May 15, 2026
Fixes pytorch#182509

Converts `docs/source/tensor_view.rst` to MyST Markdown as part of the PyTorch Docathon rST-to-MyST migration

Changes:
- Renamed `tensor_view.rst` to `tensor_view.md` using `git mv`
- Kept the pure rename as a separate first commit to preserve history
- Converted the page anchor, heading, code blocks, note block, links, and Sphinx roles to MyST Markdown syntax
- Kept the rendered documentation content equivalent to the original page

Validation:
- `lintrunner -m main`

Note:
The first commit is a pure rename-only commit showing `docs/source/tensor_view.rst` renamed to `docs/source/tensor_view.md` without content changes

Pull Request resolved: pytorch#182620
Approved by: https://github.com/svekars
aperson30 pushed a commit to aperson30/pytorch that referenced this pull request Jun 20, 2026
Fixes pytorch#182509

Converts `docs/source/tensor_view.rst` to MyST Markdown as part of the PyTorch Docathon rST-to-MyST migration

Changes:
- Renamed `tensor_view.rst` to `tensor_view.md` using `git mv`
- Kept the pure rename as a separate first commit to preserve history
- Converted the page anchor, heading, code blocks, note block, links, and Sphinx roles to MyST Markdown syntax
- Kept the rendered documentation content equivalent to the original page

Validation:
- `lintrunner -m main`

Note:
The first commit is a pure rename-only commit showing `docs/source/tensor_view.rst` renamed to `docs/source/tensor_view.md` without content changes

Pull Request resolved: pytorch#182620
Approved by: https://github.com/svekars
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docathon-2026 PyTorch Docathon H1 2026 easy label for easy docathon tasks Merged module: docs Related to our documentation, both in docs/ and docblocks open source rst-to-md 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.

[Docathon] Convert tensor_view.rst from rST to MyST Markdown

4 participants