8000 Convert to markdown: named_tensor.rst, nested.rst, nn.attention.bias.rst, nn.attention.experimental.rst, nn.attention.flex_attention.rst · Issue #155028 · pytorch/pytorch · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
Convert to markdown: named_tensor.rst, nested.rst, nn.attention.bias.rst, nn.attention.experimental.rst, nn.attention.flex_attention.rst #155028
Closed
@svekars

Description

@svekars

Convert the following files to MyST markdown and ensure that the doc tests are green:

To convert an .rst file:

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

  2. Important! Use git mv filename.rst filename.md to convert the issue from .rst to .md. DO NOT delete
    the .rst and create the .md - we won't accept PRs with deleted .rst files. We want to preserve the git log of
    those files. Therefore, using git mv is very important!

  3. Before submitting a PR, build the docs locally as described in the README.
    Preview localy with make serve to ensure that the HTML renders correctly.

  4. Run lintrunner from the root of the repository:

    pip install lintrunner
    lintrunner init
    lintrunner -m main
    
  5. 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.

    Make sure your PR is tagged with docathon-h1-2025, module: docs, topic: not user facing,
    and topic: docs labels.

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

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

See Quick MyST Conversion Reference
in our wiki or MyST Parser documentation for detailed syntax.

Here is an example PR

cc @sekyondaMeta @AlannaBurke

Metadata

Metadata

Assignees

Labels

docathon-h1-2025mediumLabel for medium docathon tasksmodule: docsRelated to our documentation, both in docs/ and docblockstriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate module

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions

    0