From 958664e0e13db4db357af692325e5a6484903823 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ezequiel=20P=C3=A1ssaro?= <epassaro15@gmail.com>
Date: Wed, 31 May 2023 14:47:41 -0300
Subject: [PATCH] Disable HDF5 file locking on documentation workflow (#2302)

---
 .github/workflows/build-docs.yml                           | 3 ++-
 docs/Makefile                                              | 4 ++--
 docs/contributing/development/documentation_guidelines.rst | 2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
index b49c0ea4e56..5d65f8468de 100644
--- a/.github/workflows/build-docs.yml
+++ b/.github/workflows/build-docs.yml
@@ -25,6 +25,7 @@ on:
 env:
   CACHE_NUMBER: 0                       # increase to reset cache manually
   DEPLOY_BRANCH: gh-pages               # deployed docs branch
+  HDF5_USE_FILE_LOCKING: 'FALSE'        # disable file locking
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
@@ -76,7 +77,7 @@ jobs:
         run: pip install -e .
 
       - name: Build documentation
-        run: cd docs/ && make html CORES=auto
+        run: cd docs/ && make html NCORES=auto
 
       - name: Set destination directory
         run: |
diff --git a/docs/Makefile b/docs/Makefile
index 04627e5229e..c32622e3bb4 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -6,7 +6,7 @@ SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = _build
-CORES         = 1
+NCORES         = 1
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4
@@ -42,7 +42,7 @@ clean:
 	-rm -rf generated
 
 html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html -j $(CORES)
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html -j $(NCORES)
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
diff --git a/docs/contributing/development/documentation_guidelines.rst b/docs/contributing/development/documentation_guidelines.rst
index a828593349c..49e40822edd 100644
--- a/docs/contributing/development/documentation_guidelines.rst
+++ b/docs/contributing/development/documentation_guidelines.rst
@@ -59,7 +59,7 @@ To build TARDIS documentation locally, use the following commands:
 
     - If you're working on a fresh local copy of the TARDIS repository, you might need to do ``python setup.py develop`` before executing these commands.
     - Use ``DISABLE_NBSPHINX=1 make html`` to disable notebook rendering (fast mode).
-    - Use ``make html CORES=<number of cores>`` to have the documentation build in parallel. Using ``make html CORES=auto`` instructs Sphinx to use all of your device's cores.
+    - Use ``make html NCORES=<number of cores>`` to have the documentation build in parallel. Using ``make html NCORES=auto`` instructs Sphinx to use all of your device's cores.
     - Use ``make html SPHINXOPTS="<insert sphinx options>"`` to include additional sphinx options, which can be found `here <https://www.sphinx-doc.org/en/master/man/sphinx-build.html#options>`_.
 
 After running this command, you can find the built docs (i.e. HTML webpages) in ``docs/_build/html``. Open the ``index.html`` in your browser to see how the documentation looks like with your edits. Navigate to page where you made changes or file that you added to check whether it looks as intended or not.