Skip to content
Closed
Show file tree
Hide file tree
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
47 changes: 22 additions & 25 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -1,42 +1,39 @@
#
name: Docs

on:
push:
branches:
- main
- master
pull_request:
workflow_call:
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
permissions: {}

jobs:
docchecks:
name: Checks
runs-on: ubuntu-22.04
outputs:
linkcheck-result: ${{ steps.linkcheck-step.outcome }}
docs-spelling:
name: Spelling
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0
- name: Python
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.12"
- name: Links
id: linkcheck-step
if: success() || failure()
uses: canonical/documentation-workflows/linkcheck@main
- name: Check spelling
run: make -C docs spelling

docs-linkcheck:
name: Links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
with:
working-directory: docs
- name: Markdown lint
id: markdown-step
if: success() || failure()
uses: DavidAnson/markdownlint-cli2-action@v16
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v6
with:
config: "docs/.sphinx/.markdownlint.json"
python-version: "3.12"
- name: Check links
run: make -C docs linkcheck
15 changes: 15 additions & 0 deletions docs/.custom_wordlist.txt
Original file line number Diff line number Diff line change
@@ -1 +1,16 @@
# Leave a blank line at the end of this file to support concatenation
backoff
boolean
Drepper
idempotently
liveness
mkdir
ns
runit
replan
subcommands
supervisord
systemd
UIDs
Ulrich
Utils
21 changes: 0 additions & 21 deletions docs/.sphinx/.markdownlint.json

This file was deleted.

23 changes: 0 additions & 23 deletions docs/.sphinx/.pre-commit-config.yaml

This file was deleted.

Loading
Loading