release_docs

#!/bin/bash

set -x

if [[ $2 ]] ; then
  set +x
  echo -e "You no longer need to set the version. Just do: ./release_docs $2"
  exit 1
fi

version=`python -c "import cf; print(cf.__version__)"`

sphinx_version=`python -c "import sphinx; print(sphinx.__version__)"`
if [[ $sphinx_version != "2.4.5"  ]] ; then
  echo "ERROR: Must (sadly) use sphinx version 2.4.5. Got $sphinx_version"
  exit 3
fi

if [[ $1 = "latest" ]] ; then 
  dir=$PWD/docs
elif [[ $1 = "archive" ]] ; then
  dir=$PWD/docs/$version
elif [[ $1 = "dev" ]] ; then
  # For testing: creates separate dir and does not (git) commit. DOES
  # NOT delete an existing .doctrees subdirectory, meaning that
  # untouched source files (.py or .rst) might not get rebuilt, even
  # if conf.py or other styling files have been modified.
  dir=$PWD/docs/dev
elif [[ $1 = "dev-clean" ]] ; then
  # For testing: creates separate dir and does not (git) commit and
  # also deletes an existing .doctrees subdirectory
    dir=$PWD/docs/dev
elif [[ $1 = "dev-scrub" ]] ; then
  # For testing: creates separate dir and does not (git) commit and
  # also completely deletes the new target directory.
  dir=$PWD/docs/dev
  rm -fr $dir
elif [[ $1 = "dev-recipes" ]] ; then
  # For testing: similar to dev, but specifically for generating recipes.
  dir=$PWD/docs/dev
else
  set +x
  echo "\$1 must be one of 'dev', 'dev-clean', 'dev-scrub', 'latest', 'archive',
  or 'dev-recipes'"
  exit 2
fi

export PYTHONPATH=$PWD:$PYTHONPATH

# Make zip of example files
cd docs/source/sample_files
zip cf_tutorial_files.zip *.nc *.pp
cd -

# Regerenate tutorial.py field_analysis.py
#if [[ $1 = "latest" ]] || [[ $1 = "archive" ]] ; then
#  ./test_tutorial_code
#  rc=$?
#  if [[ $rc != 0 ]]; then
#    echo "test_tutorial_code failed."
#    # exit $rc
#  fi
#  pre-commit run --files tutorial.py field_analysis.py 
#fi

# --------------------------------------------------------------------
# Make the latest docs    
# --------------------------------------------------------------------
cd docs
#if [[ $1 = "latest" ]] || [[ $1 = "archive" ]] || [[ $1 = "dev-clean" ]] ; the#n
#  rm -fr $dir/.doctrees
#fi
mkdir -p $dir/_downloads

#if [[ $1 = "latest" ]] || [[ $1 = "archive" ]] ; then
#  # Force recreation of recipes
#  rm source/recipes/*.md5
#fi

export CF_DOCS_MODE=$1

make html $dir
rc=$?
if [[ $rc != 0 ]]; then
    echo "ERROR: Failed in: make html $dir"
    exit $rc
fi

cp -pv source/sample_files/cf_tutorial_files.zip source/tutorial.py source/field_analysis.py $dir/_downloads

for download_file in cf_tutorial_files.zip tutorial.py field_analysis.py cheatsheet.pdf
do
  # Remove the hash string component added by GitHub to the link
  # where the resources are hosted (GH changes it to something like
  # '_downloads/4cd32e1c6bdf28fb61e15ffab2a8d84e/download_file')
  sed -i "s/\(href=._downloads\).*\($download_file\)/\1\/\2/" \
    $dir/tutorial.html \
    $dir/analysis.html \
    $dir/cheat_sheet.html
    # all pages referencing these resources must be added to this list
done

# For Recipes
recipes_dir="source/recipes"
recipes_files=( "${recipes_dir}"/*_{recipe,helper}.{ipynb,py} )

files_to_copy=(
    "${recipes_dir}/recipes_jupyter.zip"
    "${recipes_dir}/recipes_python.zip"
    "${recipes_files[@]}"
)

destination_dir="$dir/_downloads"

cp -pv "${files_to_copy[@]}" "$destination_dir"

html_files=(
    "$dir/recipes/index.html"
    "$dir/recipes/"*.html
)

for html_file in "${html_files[@]}"; do
    for recipe_file in "${files_to_copy[@]}"; do
        sed -i "s|href=\".*\/${recipe_file##*/}\"|href=\"../_downloads/${recipe_file##*/}\"|g" "$html_file"
    done
done

# Recipe filters
while IFS= read -r href; do
  IFS= read -r div
  awk -v href="$href" -v div="$div" '
  {
    if ($0 ~ href) {
      gsub("<div class=\"sphx-glr-thumbcontainer\"[^>]*>", div, prev)
    }
    print prev
    prev = $0
  }
  END {print prev}
  ' $dir/recipes/index.html > temp && mv temp $dir/recipes/index.html
done < source/recipes/recipe_list.txt

# Copy over our custom stylesheet. It is referenced in the HTML docs
# files but Sphinx with alabaster theme doesn't seem to (?) provide a
# means to transfer it to the created _static dir via the build itself
# *when* the output dir is the top-level one (hence copy works for
# 'dev' & 'archive' builds to sub-dirs).  Seemingly relates to the
# build warning:
#   WARNING: html_static_path entry '_static' is placed inside outdir
if [[ $1 = "latest" ]] ; then
  cp source/_static/customise-alabaster.css _static/customise-alabaster.css
fi

# Copy the templates to the target directory
if [[ $1 != "latest" ]] ; then
  rm -fr $dir/_templates
  cp -pr _templates $dir
fi

# --------------------------------------------------------------------
# Add and commit the latest
# --------------------------------------------------------------------
if [[ $1 = "latest" ]] ; then
  cd $dir
  git add \
          *.html \
	  class/*.html \
	  function/*.html \
	  method/*.html \
	  attribute/*.html \
	  recipes/*.html \
          *.inv \
          *.js \
          _static \
          _templates \
          _downloads/*.zip \
          _downloads/*.ipynb \
          _downloads/*.py \
          _images/*.png \
          _images/*.svg

  git commit -a -m "v$version documentation"
fi

set +x

echo PYTHONATH=$PYTHONPATH