Skip to content

ci/rtfd: building both fast docs on PR #18738

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Oct 7, 2023
Merged

ci/rtfd: building both fast docs on PR #18738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6ffbb37
ci/rtfd: building both fast docs on PR
Borda Oct 6, 2023
2032ef8
py_tree
Borda Oct 6, 2023
4d41715
cleaning
Borda Oct 6, 2023
40b111e
center
Borda Oct 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,15 @@ build:
commands:
- printenv
- pwd ; ls -lh
- pip install -U pip awscli --user
- pip install -U pip awscli py-tree --user
- python -m awscli s3 sync --no-sign-request s3://sphinx-packages/ dist/ ; ls -lh dist/
- >
pip install -e . -q -r requirements/pytorch/docs.txt -r _notebooks/.actions/requires.txt \
pip install -e . -q -r _notebooks/.actions/requires.txt \
-r requirements/fabric/docs.txt \
-r requirements/pytorch/docs.txt \
-f 'https://download.pytorch.org/whl/cpu/torch_stable.html' -f dist/ ;
pip list
# this need to be split so `sphinx-build` is picked from previous installation
- bash docs/rtfd-build.sh
- mkdir -p _readthedocs ; mv docs/build/html _readthedocs/html
- cd docs/build ; python -m py_tree --depth_limit=1
- mkdir -p _readthedocs ; mv docs/build _readthedocs/html
15 changes: 15 additions & 0 deletions docs/crossroad.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!doctype html>
<html>
<head>
<title>RTFD cross-road</title>
<style>
body {
text-align: center;
}
</style>
</head>
<body>
<a href="fabric/"><button>Fabric</button></a>
<a href="pytorch/"><button>PyTorch</button></a>
</body>
</html>
21 changes: 16 additions & 5 deletions docs/rtfd-build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,23 @@

if ! [ $READTHEDOCS_VERSION == "latest" -o $READTHEDOCS_VERSION == "stable" ];
then
cd ./docs/source-pytorch ;
export FAST_DOCS_DEV=1 ;
make html --jobs $(nproc) ;
ls -lh ../build
root=$(pwd) ;
# build Fabric
cd $root/docs/source-fabric ;
make html --jobs $(nproc) ;
cd $root/docs ;
mv build/html build/fabric ;
# build PyTorch
cd $root/docs/source-pytorch ;
make html --jobs $(nproc) ;
cd $root/docs ;
mv build/html build/pytorch ;
# cross-road
rm -rf build/doctrees ;
cp crossroad.html build/index.html
else
echo "Void build... :-]" ;
mkdir -p ./docs/build/html
cp ./docs/redirect.html ./docs/build/html/index.html
mkdir -p ./docs/build
cp ./docs/redirect.html ./docs/build/index.html
fi