Skip to content

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

Description

@svekars

Description

Convert docs/source/tensor_view.rst from reStructuredText to MyST Markdown and ensure that doc tests pass.

Steps

  1. Assign the issue to yourself using the /assigntome comment.

  2. Rename the file using git mv:

    git mv docs/source/tensor_view.rst docs/source/tensor_view.md

    Important! Use git mv to convert the file — DO NOT delete the .rst and create a new .md.
    We won't accept PRs with deleted .rst files. We want to preserve the git log.

  3. Convert the content from rST to MyST Markdown syntax.

  4. Build the docs locally as described in the README.
    Preview locally with make serve to ensure the HTML renders correctly.

  5. Run lintrunner from the root of the repository:

    pip install lintrunner
    lintrunner init
    lintrunner -m main
  6. Submit a PR with your changes and ensure the PR passes the doc CI tests. Specifically it needs to pass:

    • pull / linux-docs / build-docs-python-false (pull_request)
    • linux-jammy-py3.9-gcc11 / test (docs_test, 1, 1, lf.linux.2xlarge)

    Doc tests start after the Docker build, which might take about 30 minutes.
    The doc build itself should take about 25 minutes. When the build is done,
    you can see the preview of your build by clicking
    📄 Preview Python docs built from this PR in the pytorch-bot comment.

  7. Label your PR with: docathon-2026, module: docs.

  8. Compare the preview of the pages you converted with the same pages on the main branch.
    The converted pages in preview must look the same as in the main branch.

  9. Once the PR is accepted, one of the maintainers will merge it.

References

cc @sekyondaMeta @AlannaBurke

Metadata

Metadata

Assignees

Labels

docathon-2026PyTorch Docathon H1 2026easylabel for easy docathon tasksmodule: docsRelated to our documentation, both in docs/ and docblocksrst-to-mdtriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions