deploy via gh-pages

[mattip]

replaces #289

This is based on the assumption that we still want a deploy workflow based on a local repo, not automated via CI.

The Makefile now has grown a few more options. The normal workflow would be make clean; make html; make serve, look at the local version or commit the changes and look at them via netlify. When a PR is merged to master, git checkout master; git pull; make serve, look one more time, then make deploy. The pages will be put into a gh-pages branch and served via github pages from that branch.

Additionally, if you want to work on a fork, you can do all of the above with
make TARGET=myname BASEURL=https://myname.github.io/numpy.org <command>
which will deploy the pages to your fork, like this. It does take ~5 minutes for the pages to redeploy, so netlify may be a better preview mechanism. But sometimes you don't want to keep pushing little changes to this repo before squashing and opening a PR.

make help works and should show helpful text

[rgommers]

Thanks Matti, this works pretty well modulo the two small issues I commented on.

[rgommers]

This is based on the assumption that we still want a deploy workflow based on a local repo, not automated via CI.

Yep that's fine for now, we can change it later if needed.

In it goes, thanks Matti!

[rgommers]

Thanks Matti, this works pretty well modulo the two small issues I commented on.

Just in case, to avoid confusion when looking at this later: I actually tested this on a different Hugo site - never used it for numpy.org.

Okay I changed my mind here. It's not worth messing with Cloudflare DNS to move to gh-pages. Serving from https://github.com/numpy/numpy.github.com has worked fine and is actually the nicer solution (keeps this repo light), so I'll look at adapting the NumPy devdocs deploy method.

[rgommers]

This is really hacky, but until the above is done, use:

hugo
cd public
# Note: ensure the numpy.github.com repo is up-to-date!
cp -R . ../../tmp/numpy.github.com/
cd ../../tmp/numpy.github.com/
git status  # if new files were added, `git add` those
git commit -a -m "Deploy latest changes"
git push origin master

[mattip]

until the above is done

Is there something actionable that I can help with?

[rgommers]

@mattip, thanks for asking - yes there is. Copying over the exact deploy method we use for the numpy devdocs to this repo, so we can deploy to the numpy.github.com repo.

[mattip]

@rgommers if you want to deploy from the gh-pages branch, I think all you need to do is move the CNAME file from numpy.github.com to this repo. Then you could use this gitub actions workflow to build and deploy.

[rgommers]

@joelachance looking into this, I think he identified the same GitHub Action. There's also Cloudflare settings to mess with, and it'd be nice to keep a couple of commits on the gh-pages branch so in case something goes wrong a deploy is easy to revert and debug.