Skip to content

Commit

Permalink
Update doc push workflow guide and requirement (#7002)
Browse files Browse the repository at this point in the history
Co-authored-by: Siyuan Liu <[email protected]>
  • Loading branch information
lsy323 and Siyuan Liu authored May 1, 2024
1 parent 0a54b2b commit 93ce054
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Before the feature is available on CircleCi side, we'll use a manual process to
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 1.5 release as example:
Take 2.3 release as example:
```
# Build pytorch/pytorch:release/1.5 and pytorch/xla:release/1.5 respectively.
# 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/1.5
cp -r build/* /tmp/xla/release/2.3
cd /tmp/xla
# Update `redirect_url` in index.md
git add .
git commit -m "Publish 1.5 documentation."
git commit -m "Publish 2.3 documentation."
git push origin gh-pages
```
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
mistune==0.8.4
sphinx==5.0.0
sphinx==5.3.0
docutils==0.16
Jinja2==3.1.3
m2r
Expand Down

0 comments on commit 93ce054

Please sign in to comment.