Doc build CI might update too frequently

[leofang]

Since we merged #325 yesterday, the latest doc has been rebuilt several times. Taking the latest commit 8e4e4f2 as example, we see the gh-pages branch was updated frequently for two reasons:

1. The Jupyter notebook hash is different in every run
   • This might have to do with Building cuda.bindings docs requires the presence of a physical GPU & valid driver #327
2. The environment.pickle doctrees generated by Sphinx are checked in
   • Q: Can we remove them from the artifacts?

[leofang]

2. The environment.pickle doctrees generated by Sphinx are checked in

   • Q: Can we remove them from the artifacts?

Related discussion: materialsproject/atomate2#345. Looks like the answer is yes.

Previously @trxcllnt and I had some conversation about binary blobs being checked in could cause git checkout slowness (it was for a different context). Perhaps Paul might have some tips for how to properly address this? 😉

[leofang]

On the pickle files: It seems to be my overlook in #183 because previously @vzhurba01 seems to be careful enough to not check them in? @vzhurba01 did your purge the pickle files before pushing?

[leofang]

The Jupyter notebook hash is different in every run

@vzhurba01 could you check if changing this from force to cache would be enough to stop updating the hash?

cuda-python/cuda_bindings/docs/source/conf.py

Line 35 in 57a710a

jupyter_execute_notebooks = "force"

Otherwise, we should set it to off or find another way (ex: just don't check in the Jupyter notebook to the gh-pages branch).

xref: https://myst-nb.readthedocs.io/en/v0.10.1/use/execute.html#triggering-notebook-execution

[vzhurba01]

With the PR ready, posted past discussions on the questions raised here:

It seems to be my overlook in #183 because previously @vzhurba01 seems to be careful enough to not check them in? @vzhurba01 did your purge the pickle files before pushing?

I simply copied everything from the html folder into doc. Perhaps the .doctrees didn't get picked up from my * wildcard.

@vzhurba01 could you check if changing this from force to cache would be enough to stop updating the hash?

To resolve #327 I'm setting it to off with the why described in #424 (comment). The proposed PR applies the remaining changes needed to resolve this.

[leofang]

Looks like we fixed it!