]> git.madduck.net Git - etc/vim.git/blob - .github/workflows/doc.yml

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Clarity: special case: avoid using variables that have the same names as methods
[etc/vim.git] / .github / workflows / doc.yml
1 name: Documentation Build
2
3 on:
4   push:
5     paths:
6       - "docs/**"
7       - "README.md"
8       - "CHANGES.md"
9       - "CONTRIBUTING.md"
10   pull_request:
11     paths:
12       - "docs/**"
13       - "README.md"
14       - "CHANGES.md"
15       - "CONTRIBUTING.md"
16
17 jobs:
18   build:
19     # We want to run on external PRs, but not on our own internal PRs as they'll be run
20     # by the push to the branch. Without this if check, checks are duplicated since
21     # internal PRs match both the push and pull_request events.
22     if:
23       github.event_name == 'push' || github.event.pull_request.head.repo.full_name !=
24       github.repository
25
26     runs-on: ubuntu-latest
27     steps:
28       - uses: actions/checkout@v2
29
30       - name: Set up Python 3.9
31         uses: actions/setup-python@v2
32         with:
33           python-version: 3.9
34
35       - name: Install dependencies
36         run: |
37           python -m pip install --upgrade pip setuptools wheel
38           python -m pip install -e "."
39           python -m pip install -r "docs/requirements.txt"
40
41       - name: Build documentation
42         run: sphinx-build -a -b html -W docs/ docs/_build/