Skip to content

Commit

Permalink
See if the issue in the docs is caught
Browse files Browse the repository at this point in the history
  • Loading branch information
snejus committed Jun 11, 2024
1 parent c2a13ee commit c8e8f58
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 5 deletions.
15 changes: 15 additions & 0 deletions .github/sphinx-problem-matcher.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"problemMatcher": [
{
"owner": "sphinx",
"pattern": [
{
"regexp": "^([^:]+):(\\d+): (WARNING: )?(.+)$",
"file": 1,
"line": 2,
"message": 4
}
]
}
]
}
12 changes: 8 additions & 4 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,11 @@ jobs:
- name: Install dependencies
run: poetry install --only=docs

- uses: sphinx-doc/github-problem-matcher@master
name: Build docs
with:
run: poe docs
- name: Add Sphinx problem matcher
run: echo "::add-matcher::.github/sphinx-problem-matcher.json"

- name: Build docs
run: |
poe docs |& tee /tmp/output
# fail the job if there are issues
grep -q " WARNING:" /tmp/output && exit 1
2 changes: 1 addition & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Other changes:
* :doc:`contributing`: Since `poetry` now manages local virtual environments,

Check failure on line 24 in docs/changelog.rst

View workflow job for this annotation

GitHub Actions / Check docs

undefined label: 'develoment-tools'
`tox` has been replaced by a task runner `poethepoet`. This change affects
beets developers and contributors. Please see updates in the
:ref:`development-tools` section for more details. Type ``poe`` while in
:ref:`develoment-tools` section for more details. Type ``poe`` while in
the project directory to see the available commands.
* Installation instructions have been made consistent across plugins
documentation. Users should simply install `beets` with an `extra` of the
Expand Down

0 comments on commit c8e8f58

Please sign in to comment.