Action to deploy documentation to gh-pages

This commit is contained in:
Stephen Williams 2022-04-15 19:48:23 -07:00
parent 752a28598b
commit 0dc8596a89
3 changed files with 57 additions and 0 deletions

36
.github/workflows/deploy_docs.yml vendored Normal file
View File

@ -0,0 +1,36 @@
name: Deploy documentation
on:
# Every push onto the main branch regerenates the documentation
push:
branches:
- 'master'
jobs:
do-deploy:
runs-on: ubuntu-latest
name: 'Build documentation on Linux'
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: |
sudo apt update -qq
sudo apt install -y make autoconf python3-sphinx
- name: Make Documentation
run: |
cd Documentation
make html
- name: Deploy to GitHub Pages
uses: crazy-max/ghaction-github-pages@v2
with:
target_branch: gh-pages
build_dir: Documentation/_build/html
jekyll: false
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@ -1 +1,2 @@
_build/
!Makefile

20
Documentation/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = IcarusVerilog
SOURCEDIR = .
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)