Holzhaus / sphinx-multiversion

Sphinx extension for building self-hosted versioned docs.
https://holzhaus.github.io/sphinx-multiversion/
BSD 2-Clause "Simplified" License
148 stars 65 forks source link

Add instructions on how to deploy using github actions #83

Open samuel-emrys opened 2 years ago

samuel-emrys commented 2 years ago

There are currently instructions on how to deploy to GitHub Pages using Travis - it's probably more relevant to have instructions for GitHub Actions now that it's matured a bit. An exemplar implementation might be useful to get people up and running quickly

bmcfee commented 2 years ago

If it's at all helpful, I've just got this set up for one of my projects: https://github.com/librosa/librosa/pull/1447

It's probably too complicated to use as an example in the documentation, but it could be a good starting point if someone wants to simplify it for tutorial purposes. The main headache that I hit was getting the branches and tags to show up properly by using fetch-level and remote branches.

A few extra tweaks that I added to make things work how I wanted: