add action for spellcheck and linkcheck

[scottyhq]

see https://github.com/codespell-project/codespell

and https://jupyterbook.org/en/stable/advanced/html.html#check-external-links-in-your-book

[scottyhq]

Can run spellcheck locally with (conda create -n codespell codespell) codespell --skip=./_build --ignore-words-list=hist,nd

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[scottyhq]

Lots of broken links, can fix those in a follow up PR https://xarray.pydata.org/en/latest/dask.html#map-blocks -> https://xarray.pydata.org/en/latest/user-guide/dask.html#map-blocks

some complicated ones are also reported as broken but do resolve https://docs.google.com/presentation/d/16CMY3g_OYr6fQplUZIDqVtG-SKZqsG8Ckwoj2oOqepU/edit#slide=id.g2b68f9254d_1_154

[max-sixty]

This is great!

Is there also a pre-commit hook for spelling? (I know for links, pre-commit.ci doesn't work because it doesn't have internet access)

[scottyhq]

Is there also a pre-commit hook for spelling?

Looks like there is! But I haven't used it. Should I add that as well or instead of the github action step? https://pre-commit.com/hooks.html

[max-sixty]

Should I add that as well or instead of the github action step?

Personally I would vote to aggregate them in pre-commit, because it's really easy to run locally. But your call!

(Also fine to merge this now to avoid conflicts and then resolve after)

[max-sixty]

We could also add the link check to pre-commit, add ci:\n skip: [markdown-link-check] to avoid it attempting in ci, but this is very refine-y, and the proposed code is already excellent.

[scottyhq]

I advocate for merging this as-is and adding to pre-commit later if desirable. While I agree it would be convenient, both of these checks can have lots of false positives and the linkchecking can hang with network failures. So they seem well suited to opt-in or PR-level checks. The jupyterbook linkchecker I think also deals with many more formats and markup (myst-markdown).

It does look possible to setup both opt-out (SKIP=codespell git commit -m "foo" ) or opt-in (pre-commit run --hook-stage manual codespell)

[dcherian]

I agree ^. Also moving quickly is beneficial at the moment given the upcoming SciPy deadline.

[max-sixty]

Very much agree re merging! Thanks for doing that!