Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Is this content still relevant? #8088

Open
mikegre-google opened this issue Sep 27, 2024 · 1 comment
Open

Is this content still relevant? #8088

mikegre-google opened this issue Sep 27, 2024 · 1 comment

Comments

@mikegre-google
Copy link
Collaborator

📚 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
Copy link
Collaborator

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants