Use Jupyter cache in gh workflow docs build

[cosenal]

Description

This is an attempt to use Github Actions Cache to restore jupyter_cache from one workflow run to the next one. That cache is created by Sphinx Myst-NB because we are setting this in the configuration.

---

Test

Unfortunately I can't test this with the awesomeact tool, because this job starts docker in one of the steps (#dockerinception). So only a merge will tell if it works 😬

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (ffa4b38) to head (39c8a44).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2279   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files          90       90           
  Lines        4263     4263           
=======================================
  Hits         4190     4190           
  Misses         73       73           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[natestemen]

Great idea. Save engineering/CI time 💪🏻.

Had a few questions, and generally since we can't test it ourselves I figured it would be good to do some searching across GitHub to see what other people are doing.

[cosenal]

@natestemen comments addressed, PTAL

[natestemen]

Let's try it out! I have had some instances locally where I needed to remove something from the cache in order to get the build to work correctly, but I haven't recreated that situation.

Just left one question, but not blocking. Thanks for answering my other questions :)

[natestemen]

Just checking my understanding: this is both fetching and setting the cache, right?

[cosenal]

Yes. My understanding is that it simply populates the specified path in the container with the content that's in cache.

[cosenal]

Unfortunately, because of that linkcheck issue, the build doesn't succeed and the cache is not populated. I will merge anyway, and hopefully we will have a chance to try it out once the build is green.

[purva-thakre]

@cosenal We could temporarily remove the make linkcheck line from the job

mitiq/.github/workflows/build.yml

Line 63 in 12c7126

- name: Build and test Sphinx docs

And add it back in when the other issue is resolved.

[cosenal]

@purva-thakre Raise a PR and I will approve it right away :)