Upload docs build in CI

[Eric-Arellano]

This is useful to iterate on docs and debug CI issues.

The artifact will be uploaded to GitHub Actions like this:

[caleb-johnson]

Any reason you like the if statement here?

[Eric-Arellano]

Like, where it is visually located? I copied the style you used from the Deploy docs job below it

[caleb-johnson]

I think we can just remove the if statement here

[Eric-Arellano]

We've found it useful to set if: always. When the Sphinx doc build fails due to warnings (e.g. bad indentation), it still produces the docs artifact. It is useful to be able to look at those docs to understand Sphinx's notoriously cryptic error messages.

[garrison]

This is useful to iterate on docs and debug CI issues.

Can you give an example of a use case? Is this artifact only useful for PRs, or is it useful for all docs builds?

EDIT: I am starting to understand more. The if: always() means it will upload this artifact even when it fails. So yes, does make sense on every run.

[caleb-johnson]

LGTM thanks 👍

I'll let @garrison take a look before approving

[Eric-Arellano]

Is this artifact only useful for PRs, or is it useful for all docs builds?

Yeah, it's useful for all CI builds. And there is little downside to this PR other than the couple lines of extra code. The upload should be fast and your docs are only 25MB.

Concrete example: we make a big styling change in #313. I want to make it easy for us all to see what the new docs will look like, without making you build the docs locally.