Skip to content

Commit 857b6a5

Browse files
Tidy CLI option processing in release_docs script
1 parent f7d977e commit 857b6a5

1 file changed

Lines changed: 14 additions & 19 deletions

File tree

release_docs

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,37 +19,32 @@ if [[ $1 = "latest" ]] ; then
1919
dir=$PWD/docs
2020
elif [[ $1 = "archive" ]] ; then
2121
dir=$PWD/docs/$version
22-
elif [[ $1 = "dev" ]] ; then
23-
# For testing: creates separate dir and does not (git) commit. DOES
24-
# NOT delete an existing .doctrees subdirectory, meaning that
25-
# untouched source files (.py or .rst) might not get rebuilt, even
26-
# if conf.py or other styling files have been modified.
27-
dir=$PWD/docs/dev
28-
elif [[ $1 = "dev-clean" ]] ; then
29-
# For testing: creates separate dir and does not (git) commit and
30-
# also deletes an existing .doctrees subdirectory
22+
elif [[ $1 = "dev" || $1 = "dev-clean" ]]; then
23+
# dev:
24+
# For testing: creates separate dir and does not (git) commit. DOES
25+
# NOT delete an existing .doctrees subdirectory, meaning that
26+
# untouched source files (.py or .rst) might not get rebuilt, even
27+
# if conf.py or other styling files have been modified.
28+
# vs.
29+
# dev-clean:
30+
# For testing: creates separate dir and does not (git) commit and
31+
# also deletes an existing .doctrees subdirectory
3132
dir=$PWD/docs/dev
3233
elif [[ $1 = "dev-scrub" ]] ; then
3334
# For testing: creates separate dir and does not (git) commit and
3435
# also completely deletes the new target directory.
3536
dir=$PWD/docs/dev
3637
rm -fr $dir
37-
# Recipes docs cases (5 in total, equivalent to main docs options)
38+
# Recipes docs cases (five in total, equivalent to main docs options) -
39+
# see comments above for main docs cases for clarifications of intent
3840
elif [[ $1 = "latest-recipes" ]] ; then
39-
# For testing: similar to dev, but specifically for generating recipes.
40-
dir=$PWD/recipes-docs
41+
dir=$PWD/recipes-docs
4142
elif [[ $1 = "archive-recipes" ]] ; then
42-
# For testing: similar to dev, but specifically for generating recipes.
4343
dir=$PWD/recipes-docs/$version
44-
elif [[ $1 = "dev-recipes" ]] ; then
45-
# For testing: similar to dev, but specifically for generating recipes.
46-
dir=$PWD/recipes-docs/dev
47-
elif [[ $1 = "dev-clean-recipes" ]] ; then
44+
elif [[ $1 = "dev-recipes" || $1 = "dev-clean-recipes" ]]; then
4845
# For testing: similar to dev, but specifically for generating recipes.
4946
dir=$PWD/recipes-docs/dev
5047
elif [[ $1 = "dev-scrub-recipes" ]] ; then
51-
# For testing: similar to dev, but specifically for generating recipes,
52-
# but cleaning any generated recipe files and gen'd dev dir first.
5348
dir=$PWD/recipes-docs/dev
5449
rm -fr $dir
5550
else

0 commit comments

Comments
 (0)