Skip to content

Commit e769e23

Browse files
authored
ci: build app's docs with RTFD (#19147)
* ci: build app's docs with RTFD * set -ex * .[app]
1 parent 360b124 commit e769e23

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

.readthedocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ build:
4242
- pip install -U pip awscli py-tree --user
4343
- python -m awscli s3 sync --no-sign-request s3://sphinx-packages/ dist/ ; ls -lh dist/
4444
- >
45-
pip install -e . -q -r _notebooks/.actions/requires.txt \
45+
pip install -e ".[app]" -q -r _notebooks/.actions/requires.txt \
46+
-r requirements/app/docs.txt \
4647
-r requirements/fabric/docs.txt \
4748
-r requirements/pytorch/docs.txt \
4849
-f 'https://download.pytorch.org/whl/cpu/torch_stable.html' -f dist/ ;

docs/crossroad.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
</style>
1010
</head>
1111
<body>
12+
<a href="app/"><button>App</button></a>
1213
<a href="fabric/"><button>Fabric</button></a>
1314
<a href="pytorch/"><button>PyTorch</button></a>
1415
</body>

docs/rtfd-build.sh

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
# building for PRs and skip stable and latest states
2+
set -ex
23

34
if ! [ $READTHEDOCS_VERSION == "latest" -o $READTHEDOCS_VERSION == "stable" ];
45
then
56
export FAST_DOCS_DEV=1 ;
67
root=$(pwd) ;
7-
# build Fabric
8-
cd $root/docs/source-fabric ;
9-
make html --jobs $(nproc) ;
10-
cd $root/docs ;
11-
mv build/html build/fabric ;
12-
# build PyTorch
13-
cd $root/docs/source-pytorch ;
14-
make html --jobs $(nproc) ;
15-
cd $root/docs ;
16-
mv build/html build/pytorch ;
8+
for pkg in 'app' 'fabric' 'pytorch' ;
9+
do
10+
cd $root/docs/source-$pkg ;
11+
make html --jobs $(nproc) ;
12+
cd $root/docs ;
13+
mv build/html build/$pkg ;
14+
done ;
1715
# cross-road
1816
rm -rf build/doctrees ;
1917
cp crossroad.html build/index.html

0 commit comments

Comments
 (0)