From 93ce054132ead2fd7720175d53f455f41575522d Mon Sep 17 00:00:00 2001 From: Siyuan Liu Date: Wed, 1 May 2024 16:51:23 -0700 Subject: [PATCH] Update doc push workflow guide and requirement (#7002) Co-authored-by: Siyuan Liu --- docs/README.md | 8 ++++---- docs/requirements.txt | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/README.md b/docs/README.md index a405597c798..88ab7f44f03 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 ``` diff --git a/docs/requirements.txt b/docs/requirements.txt index 411e6642ff7..0d0f871b154 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ mistune==0.8.4 -sphinx==5.0.0 +sphinx==5.3.0 docutils==0.16 Jinja2==3.1.3 m2r