Skip to content

CI for building doc with sphinx #7638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 13, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 61 additions & 0 deletions .github/workflows/users-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Adapted from agda/agda/.github/workflows/user-manual.yml by Andreas, 2021-09-11

name: Users guide

on:
push:
branches:
- master
paths:
- 'doc/requirements.txt'
- 'doc/*.inc'
- 'doc/*.py'
- 'doc/*.rst'
- 'doc/**/*.json'
- '.github/workflows/users-guide.yml'
pull_request:
paths:
- 'doc/requirements.txt'
- 'doc/*.inc'
- 'doc/*.py'
- 'doc/*.rst'
- 'doc/**/*.json'
- '.github/workflows/users-guide.yml'
release:
types:
- created

jobs:
build:
if: |
!contains(github.event.head_commit.message, '[skip ci]')
&& !contains(github.event.head_commit.message, '[ci skip]')

runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.7]

steps:
- uses: actions/checkout@v2
with:
submodules: recursive

- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}

# Subsumed by make users-guide
# - name: Install dependencies
# run: |
# pip install -r doc/requirements.txt

- name: Build User's Guide in HTML
run: |
make SPHINX_HTML_OUTDIR=html users-guide

- uses: actions/upload-artifact@v2
with:
name: users-guide-html
path: html/