-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9e71734
commit 5a0f670
Showing
2 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# yaml-language-server: $schema=https://json.schemastore.org/github-workflow | ||
|
||
name: "Sphinx" | ||
|
||
on: # yamllint disable-line rule:truthy | ||
pull_request: | ||
paths: | ||
- "**/*.rst" | ||
push: | ||
branches: | ||
- "master" | ||
paths: | ||
- "**/*.rst" | ||
workflow_call: null | ||
# Add [skip ci] to commit message to skip CI. | ||
|
||
permissions: {} # yamllint disable-line rule:braces | ||
#permissions: "read-all" | ||
#permissions: | ||
# contents: "read" # Private repositories need read permission | ||
|
||
concurrency: | ||
group: "${{ github.workflow }}-${{ github.ref }}" | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
sphinx: | ||
name: "Sphinx reStructuredText validity" | ||
runs-on: "ubuntu-22.04" | ||
timeout-minutes: 1 | ||
steps: | ||
- | ||
name: "Checkout repository" | ||
uses: "actions/[email protected]" | ||
- | ||
name: "Cache pip" | ||
uses: "actions/[email protected]" | ||
with: | ||
path: "~/.cache/pip" | ||
key: "${{ runner.os }}-pip-sphinx-lint" | ||
- | ||
name: "Install sphinx-lint" | ||
run: | | ||
pip install --user sphinx-lint | ||
- | ||
name: "Check Sphinx document sources" | ||
run: | | ||
git ls-files --cached -z -- '*.rst' \ | ||
| xargs --null -- python -m sphinxlint --enable all --max-line-length 120 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Welcome to Byte-level care! | ||
=========================== | ||
|
||
Living with zero problems while developing your web application. | ||
Currently includes workflows for GitHub Actions. | ||
|
||
.. note:: | ||
|
||
This project is under active development. |