Update docs dependencies for local build #151796

svekars · 2025-04-21T16:15:37Z

Fixes #151786

Changed requirements.txt to a symlink to .ci/docker/requirements-docs.txt
Updated README.md with better doc build instructions.

cc @sekyondaMeta @AlannaBurke

pytorch-bot · 2025-04-21T16:15:40Z

🔗 Helpful Links

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

📄 Preview Python docs built from this PR
📄 Preview C++ docs built from this PR
❓ Need help or want to give feedback on the CI? Visit the bot commands wiki or our office hours

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

✅ No Failures

As of commit 57d1180 with merge base 9422e24 ():
💚 Looks good so far! There are no failures yet. 💚

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

AlannaBurke · 2025-04-21T18:12:31Z

README.md

+> If you installed `nodejs` with a different package manager (e.g.,
 > `conda`) then `npm` will probably install a version of `katex` that is not
-> compatible with your version of `nodejs` and doc builds will fail.
+> ccompatible with your version of `nodejs` and doc builds will fail.


README.md

malfet

LGTM

malfet · 2025-04-23T17:41:09Z

@pytorchbot rebase

pytorchmergebot · 2025-04-23T17:42:40Z

@pytorchbot started a rebase job onto refs/remotes/origin/viable/strict. Check the current status here

pytorchmergebot · 2025-04-23T17:42:42Z

Tried to rebase and push PR #151796, but it was already up to date. Try rebasing against main by issuing:
@pytorchbot rebase -b main

svekars · 2025-04-23T17:57:50Z

@pytorchbot merge

pytorchmergebot · 2025-04-23T18:01:01Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

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

malfet · 2025-04-23T18:29:08Z

@pytorchbot merge

pytorchmergebot · 2025-04-23T18:29:25Z

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

pytorchmergebot · 2025-04-23T18:31:07Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

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

pytorchmergebot · 2025-04-24T00:29:49Z

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

svekars · 2025-04-24T17:17:37Z

@pytorchbot merge

pytorchmergebot · 2025-04-24T17:19:21Z

Merge started

Your change will be merged once all checks pass (ETA 0-4 Hours).

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

malfet · 2025-04-24T18:37:56Z

@pytorchbot merge -f "Spartaaaaaa!"

pytorch-bot · 2025-04-24T18:38:00Z

You need to provide a reason for using force merge, in the format @pytorchbot merge -f 'Explanation'.
The explanation needs to be clear on why this is needed. Here are some good examples:

Bypass checks due to unrelated upstream failures from ...
This is a minor fix to ..., which shouldn't break anything
This is pre-tested in a previous CI run
Bypass flaky ... check

malfet · 2025-04-24T18:38:32Z

@pytorchbot merge -f 'Explanation: GitHub could not schedule pull workflows for the 2nd time'

pytorchmergebot · 2025-04-24T18:38:50Z

The merge job was canceled or timed out. This most often happen if two merge requests were issued for the same PR, or if merge job was waiting for more than 6 hours for tests to finish. In later case, please do not hesitate to reissue the merge command
For more information see pytorch-bot wiki.

pytorchmergebot · 2025-04-24T18:40:30Z

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

Fixes pytorch#151786 - Changed requirements.txt to a symlink to .ci/docker/requirements-docs.txt - Updated README.md with better doc build instructions. Pull Request resolved: pytorch#151796 Approved by: https://github.com/malfet

@malfet

Before this change, there was the requirements file `.ci/docker/requirements-docs.txt` which was symlinked as `../.ci/docker/requirements-docs.txt` from `docs/requirements.txt` since #151796. In this situation, [because `.ci` is excluded from the source tarball](https://github.com/pytorch/pytorch/blob/3173616532ecf0d5c0b78595d6054f1b4bd2bd75/.github/workflows/create_release.yml#L67), we end up with a broken symlink, that additionally is [invalid in a Python source distribution](https://packaging.python.org/en/latest/specifications/source-distribution-format/#unpacking-without-the-data-filter). The broken symlink can be confirmed in [the rc sources](https://github.com/pytorch/pytorch/actions/runs/15892205745). ~After this change, there is still a single source of truth, which now is `docs/requirements.txt`, symlinked as `../docs/requirements.txt` from `.ci/docker/requirements-docs.txt`, which would also be invalid in a Python source distribution, but is not included in the tarball (see above). Additionally, the docs requirements that were missing from the previous tarball, are now actually included, allowing users to build the documentation again.~ @malfet clarified offline that there is a problem with the docs workflows because they use a cache with a key that includes the hash of the requirements document in the `.ci` folder, which now does no longer change when the requirements change. Hence, a different solution is needed~, though for now the problem remains~. The solution in this PR is simply to copy the actual document to replace the symlink just prior to creating the source distribution. This way, a single document needs to be maintained, git checkouts remain as they are, and the source distributions contain the before-missing document. A better solution may be implemented at a later stage with a better build system. Pull Request resolved: #157811 Approved by: https://github.com/atalman

@malfet

…157811) Before this change, there was the requirements file `.ci/docker/requirements-docs.txt` which was symlinked as `../.ci/docker/requirements-docs.txt` from `docs/requirements.txt` since pytorch#151796. In this situation, [because `.ci` is excluded from the source tarball](https://github.com/pytorch/pytorch/blob/3173616532ecf0d5c0b78595d6054f1b4bd2bd75/.github/workflows/create_release.yml#L67), we end up with a broken symlink, that additionally is [invalid in a Python source distribution](https://packaging.python.org/en/latest/specifications/source-distribution-format/#unpacking-without-the-data-filter). The broken symlink can be confirmed in [the rc sources](https://github.com/pytorch/pytorch/actions/runs/15892205745). ~After this change, there is still a single source of truth, which now is `docs/requirements.txt`, symlinked as `../docs/requirements.txt` from `.ci/docker/requirements-docs.txt`, which would also be invalid in a Python source distribution, but is not included in the tarball (see above). Additionally, the docs requirements that were missing from the previous tarball, are now actually included, allowing users to build the documentation again.~ @malfet clarified offline that there is a problem with the docs workflows because they use a cache with a key that includes the hash of the requirements document in the `.ci` folder, which now does no longer change when the requirements change. Hence, a different solution is needed~, though for now the problem remains~. The solution in this PR is simply to copy the actual document to replace the symlink just prior to creating the source distribution. This way, a single document needs to be maintained, git checkouts remain as they are, and the source distributions contain the before-missing document. A better solution may be implemented at a later stage with a better build system. Pull Request resolved: pytorch#157811 Approved by: https://github.com/atalman

@malfet

…157811) Before this change, there was the requirements file `.ci/docker/requirements-docs.txt` which was symlinked as `../.ci/docker/requirements-docs.txt` from `docs/requirements.txt` since pytorch#151796. In this situation, [because `.ci` is excluded from the source tarball](https://github.com/pytorch/pytorch/blob/3173616532ecf0d5c0b78595d6054f1b4bd2bd75/.github/workflows/create_release.yml#L67), we end up with a broken symlink, that additionally is [invalid in a Python source distribution](https://packaging.python.org/en/latest/specifications/source-distribution-format/#unpacking-without-the-data-filter). The broken symlink can be confirmed in [the rc sources](https://github.com/pytorch/pytorch/actions/runs/15892205745). ~After this change, there is still a single source of truth, which now is `docs/requirements.txt`, symlinked as `../docs/requirements.txt` from `.ci/docker/requirements-docs.txt`, which would also be invalid in a Python source distribution, but is not included in the tarball (see above). Additionally, the docs requirements that were missing from the previous tarball, are now actually included, allowing users to build the documentation again.~ @malfet clarified offline that there is a problem with the docs workflows because they use a cache with a key that includes the hash of the requirements document in the `.ci` folder, which now does no longer change when the requirements change. Hence, a different solution is needed~, though for now the problem remains~. The solution in this PR is simply to copy the actual document to replace the symlink just prior to creating the source distribution. This way, a single document needs to be maintained, git checkouts remain as they are, and the source distributions contain the before-missing document. A better solution may be implemented at a later stage with a better build system. Pull Request resolved: pytorch#157811 Approved by: https://github.com/atalman

svekars added module: docs Related to our documentation, both in docs/ and docblocks topic: docs topic category labels Apr 21, 2025

pytorch-bot bot added the topic: not user facing topic category label Apr 21, 2025

svekars requested a review from malfet April 21, 2025 16:15

AlannaBurke reviewed Apr 21, 2025

View reviewed changes

svekars commented Apr 21, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

svekars added 4 commits April 23, 2025 10:12

Update docs dependencies for local build

2ef4eba

Small fix

4f45f23

Fix a typo

d8b3e01

Make requirements.txt a symlink

57d1180

svekars force-pushed the update-doc-dependencies-local branch from b800825 to 57d1180 Compare April 23, 2025 17:13

malfet approved these changes Apr 23, 2025

View reviewed changes

pytorch-bot bot added the ciflow/trunk Trigger trunk jobs on your pull request label Apr 23, 2025

pytorchmergebot added the merging label Apr 23, 2025

svekars mentioned this pull request Apr 24, 2025

Issue while Building the Documentation #151901

Closed

pytorchmergebot closed this in ff075d0 Apr 24, 2025

pytorchmergebot added Merged and removed merging labels Apr 24, 2025

github-actions bot deleted the update-doc-dependencies-local branch June 12, 2025 02:21

This was referenced Jul 2, 2025

Add standard Python source distribution generation to (pre-)release workflow #152098

Closed

For sdists, replace symlink with copy for docs requirements #157811

Closed

malfet mentioned this pull request Jul 14, 2025

Docs: revise external link in build section for accuracy #158201

Open

Update docs dependencies for local build #151796

Update docs dependencies for local build #151796

Uh oh!

Conversation

svekars commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pytorch-bot bot commented Apr 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔗 Helpful Links

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

✅ No Failures

Uh oh!

AlannaBurke Apr 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

malfet left a comment

Choose a reason for hiding this comment

Uh oh!

malfet commented Apr 23, 2025

Uh oh!

pytorchmergebot commented Apr 23, 2025

Uh oh!

pytorchmergebot commented Apr 23, 2025

Uh oh!

svekars commented Apr 23, 2025

Uh oh!

pytorchmergebot commented Apr 23, 2025

Merge started

Uh oh!

malfet commented Apr 23, 2025

Uh oh!

pytorchmergebot commented Apr 23, 2025

Uh oh!

pytorchmergebot commented Apr 23, 2025

Merge started

Uh oh!

pytorchmergebot commented Apr 24, 2025

Uh oh!

svekars commented Apr 24, 2025

Uh oh!

pytorchmergebot commented Apr 24, 2025

Merge started

Uh oh!

malfet commented Apr 24, 2025

Uh oh!

pytorch-bot bot commented Apr 24, 2025

Uh oh!

malfet commented Apr 24, 2025

Uh oh!

pytorchmergebot commented Apr 24, 2025

Uh oh!

pytorchmergebot commented Apr 24, 2025

Merge started

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

svekars commented Apr 21, 2025 •

edited

Loading

pytorch-bot bot commented Apr 21, 2025 •

edited

Loading