Skip to content

Commit 00aaceb

Browse files
authored
ci: enable new spelling check by updating doc starter pack (canonical#774)
This PR updates Pebble to version 1.3.1 of the [doc starter pack](https://github.com/canonical/sphinx-docs-starter-pack). The main change is a new spelling check. I've reorganised our docs CI, so the most important file to review is `.github/workflows/docs.yaml`. The other changes follow the latest changed files in the starter pack. I've taken this opportunity to remove starter pack files that we don't use in Pebble, to keep things tidy. (I probably originally advocated for keeping them, but now I think they add noise.)
1 parent 3302bd0 commit 00aaceb

File tree

13 files changed

+86
-566
lines changed

13 files changed

+86
-566
lines changed

.github/workflows/docs.yaml

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,39 @@
1-
#
21
name: Docs
32

43
on:
54
push:
65
branches:
7-
- main
6+
- master
87
pull_request:
9-
workflow_call:
108
workflow_dispatch:
119

12-
concurrency:
13-
group: ${{ github.workflow }}-${{ github.ref }}
14-
cancel-in-progress: true
10+
permissions: {}
1511

1612
jobs:
17-
docchecks:
18-
name: Checks
19-
runs-on: ubuntu-22.04
20-
outputs:
21-
linkcheck-result: ${{ steps.linkcheck-step.outcome }}
13+
docs-spelling:
14+
name: Spelling
15+
runs-on: ubuntu-latest
2216
steps:
23-
- name: Checkout
24-
uses: actions/checkout@v6
17+
- uses: actions/checkout@v6
2518
with:
26-
fetch-depth: 0
27-
- name: Python
19+
persist-credentials: false
20+
- name: Set up Python
2821
uses: actions/setup-python@v6
2922
with:
3023
python-version: "3.12"
31-
- name: Links
32-
id: linkcheck-step
33-
if: success() || failure()
34-
uses: canonical/documentation-workflows/linkcheck@main
24+
- name: Check spelling
25+
run: make -C docs spelling
26+
27+
docs-linkcheck:
28+
name: Links
29+
runs-on: ubuntu-latest
30+
steps:
31+
- uses: actions/checkout@v6
3532
with:
36-
working-directory: docs
37-
- name: Markdown lint
38-
id: markdown-step
39-
if: success() || failure()
40-
uses: DavidAnson/markdownlint-cli2-action@v16
33+
persist-credentials: false
34+
- name: Set up Python
35+
uses: actions/setup-python@v6
4136
with:
42-
config: "docs/.sphinx/.markdownlint.json"
37+
python-version: "3.12"
38+
- name: Check links
39+
run: make -C docs linkcheck

docs/.sphinx/.markdownlint.json

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/.sphinx/.pre-commit-config.yaml

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)