-
Notifications
You must be signed in to change notification settings - Fork 27.7k
[Docathon] Convert cudnn_rnn_determinism.rst from rST to MyST Markdown #182462
Copy link
Copy link
Open
Labels
bot-triagedThis is a label only to be used by the auto triage botThis is a label only to be used by the auto triage botdocathon-2026PyTorch Docathon H1 2026PyTorch Docathon H1 2026enhancementNot as big of a feature, but technically not a bug. Should be easy to fixNot as big of a feature, but technically not a bug. Should be easy to fixmodule: docsRelated to our documentation, both in docs/ and docblocksRelated to our documentation, both in docs/ and docblockstopic: docstopic categorytopic categorytopic: not user facingtopic categorytopic categorytriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
Metadata
Metadata
Assignees
Labels
bot-triagedThis is a label only to be used by the auto triage botThis is a label only to be used by the auto triage botdocathon-2026PyTorch Docathon H1 2026PyTorch Docathon H1 2026enhancementNot as big of a feature, but technically not a bug. Should be easy to fixNot as big of a feature, but technically not a bug. Should be easy to fixmodule: docsRelated to our documentation, both in docs/ and docblocksRelated to our documentation, both in docs/ and docblockstopic: docstopic categorytopic categorytopic: not user facingtopic categorytopic categorytriagedThis issue has been looked at a team member, and triaged and prioritized into an appropriate moduleThis issue has been looked at a team member, and triaged and prioritized into an appropriate module
Description
Convert
docs/source/cudnn_rnn_determinism.rstfrom reStructuredText to MyST Markdown and ensure that doc tests pass.Steps
Assign the issue to yourself using the
/assigntomecomment.Rename the file using
git mv:Important! Use
git mvto convert the file — DO NOT delete the.rstand create a new.md.We won't accept PRs with deleted
.rstfiles. We want to preserve the git log.Convert the content from rST to MyST Markdown syntax.
If you want to use AI for the conversion, we had very good results with
this converter script.
Build the docs locally as described in the README.
Preview locally with
make serveto ensure the HTML renders correctly.Run lintrunner from the root of the repository:
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.
Label your PR with:
docathon-h1-2025,module: docs,topic: not user facing,topic: docs.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.
Once the PR is accepted, one of the maintainers will merge it.
References
cc @svekars @sekyondaMeta @AlannaBurke