Skip to content
Merged
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
20 changes: 20 additions & 0 deletions .github/workflows/linkcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Link check

# Allow to trigger on pull requests and manually via Github Actions
on:
pull_request:
workflow_dispatch:

jobs:
build:
# Use Ubuntu as environment
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v1
# This external action cares about all the sphinx stuff
- uses: ammaraskar/sphinx-action@4.3.2
with:
build-command: "sphinx-build -b linkcheck source/ build/"
docs-folder: "docs/"

5 changes: 5 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,8 @@

# Disable link "Show Source"
html_show_sourcelink = False

# -- Options for the linkcheck builder ---------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder

linkcheck_anchors = False
Loading