]> 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:

Upgrade docs to Sphinx 3+ and add doc build test (#1613)
[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     runs-on: ubuntu-latest
20
21     steps:
22       - uses: actions/checkout@v2
23
24       - name: Set up Python 3.8
25         uses: actions/setup-python@v2
26         with:
27           python-version: 3.8
28
29       - name: Install dependencies
30         run: |
31           python -m pip install --upgrade pip setuptools wheel
32           python -m pip install -e "."
33           python -m pip install -r "docs/requirements.txt"
34
35       - name: Build documentation
36         run: sphinx-build -a -b html -W docs/ docs/_build/