pytorch / xla

Enabling PyTorch on XLA Devices (e.g. Google TPU)
https://pytorch.org/xla
Other
2.48k stars 480 forks source link

Is this content still relevant? #8088

Open mikegre-google opened 1 month ago

mikegre-google commented 1 month ago

📚 Documentation

xla/docs/README contains the following text. Is this text still relevant? The link to CircleCi is broken and I'm not sure if this information is useful:

Publish documentation for a new release.

CI job pytorch_xla_linux_debian11_and_push_doc is specified to run on release/* branches, but it was not run on release branches due to "Only build pull requests" setting. Turning off "Only build pull requests" will result in much larger volumes in jobs which is often unnecessary. We're waiting for this feature request to be implemented so that we could override this setting on some branches.

Before the feature is available on CircleCi side, we'll use a manual process to publish documentation for release. Documentation for master branch is still updated automatically by the CI job. But we'll need to manually commit the new versioned doc and point http://pytorch.org/xla to the documentation of new stable release.

Take 2.3 release as example:

# Build pytorch/pytorch:release/2.3 and pytorch/xla:release/2.3 respectively.
# In pytorch/xla/docs
./docs_build.sh
git clone -b gh-pages https://github.com/pytorch/xla.git /tmp/xla
cp -r build/* /tmp/xla/release/2.3
cd /tmp/xla
# Update `redirect_url` in index.md
git add .
git commit -m "Publish 2.3 documentation."
git push origin gh-pages

I would suggest we remove this and replace it with instuctions on how to update index.rst to include any new documentation on pytorch.org.

JackCaoG commented 1 month ago

It is still relevant, this is how we push to our doc to pytorch org for release branches.