Merge pull request #174 from aragilar/fix-api-docs

Hopefully fix API docs

.github/workflows/test-overall.yml

@@ -124,3 +124,4 @@ jobs:
         tox
       env:
         TOXENV: ${{ matrix.tox-env }}
+        UPLOAD_SCIKITS_ODES_API_DOCS: ${{ github.repository == 'bmcage/odes' && 'true' || 'false' }}

apidocs/upload_api_docs.sh

@@ -2,18 +2,22 @@
 
 set -ex
 
-# Clone gh-pages
-git clone --branch gh-pages https://github.com/bmcage/odes gh-pages
-# Run rsync
-branch_name="$GITHUB_REF_NAME"
-rsync -av --delete "$API_DOCS_OUT_DIR" "./gh-pages/$branch_name/"
-# Run docs-versions-menu
-cd gh-pages
-docs-versions-menu
-# Commit and push
-git config user.name github-actions
-git config user.email [email protected]
-git add -A --verbose
-git status
-git commit --verbose -m "Auto-update from Github Actions Workflow" -m "Deployed from commit ${GITHUB_SHA} (${GITHUB_REF})"
-git push --verbose --force "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/bmcage" gh-pages
+if [ "true" = "$UPLOAD_SCIKITS_ODES_API_DOCS" ]; then
+    # Clone gh-pages
+    git clone --branch gh-pages https://github.com/bmcage/odes gh-pages
+    # Run rsync
+    branch_name="$GITHUB_REF_NAME"
+    rsync -av --delete "$API_DOCS_OUT_DIR" "./gh-pages/$branch_name/"
+    # Run docs-versions-menu
+    cd gh-pages
+    docs-versions-menu
+    # Commit and push
+    git config user.name github-actions
+    git config user.email [email protected]
+    git add -A --verbose
+    git status
+    git commit --verbose -m "Auto-update from Github Actions Workflow" -m "Deployed from commit ${GITHUB_SHA} (${GITHUB_REF})"
+    git push --verbose --force "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/bmcage" gh-pages
+else
+    echo "Skipping upload of API docs"
+fi

tox.ini

@@ -39,7 +39,7 @@ deps=
     -rapidocs/requirements.txt
 commands=
     sphinx-build -W -b html -d {envtmpdir}/doctrees . {env:API_DOCS_OUT_DIR}
-    upload: ./upload_api_docs.sh
+    ./upload_api_docs.sh
 changedir=apidocs
 
 [testenv:docs]