-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
link generation was breaking becuase of a link to docker-compose which has now been removed. Also update the CI github action to use poetry to install deps and potentially resolve build error
- Loading branch information
1 parent
e0ece67
commit 80309c1
Showing
3 changed files
with
225 additions
and
19 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 |
---|---|---|
@@ -1,27 +1,29 @@ | ||
name: Verify documentation | ||
on: | ||
push: | ||
branches: [ "main", "master" ] | ||
branches: ["main", "master"] | ||
pull_request: | ||
branches: [ "main", "master" ] | ||
branches: ["main", "master"] | ||
|
||
jobs: | ||
verify-docs: | ||
name: Check Documentation | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: ${{ matrix.python-version }} | ||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install .[tests] | ||
- name: Build docs with MkDocs | ||
run: | | ||
make docs | ||
- name: Check Markdown links | ||
uses: gaurav-nelson/github-action-markdown-link-check@v1 | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Set up Python ${{ matrix.python-version }} | ||
uses: actions/setup-python@v4 | ||
with: | ||
python-version: "3.10" | ||
- name: Install Poetry | ||
run: curl -sSL https://install.python-poetry.org | python | ||
- name: Install dependencies | ||
run: | | ||
poetry env use '3.10' | ||
poetry install --extras=testing | ||
- name: Build docs with MkDocs | ||
run: | | ||
make docs | ||
- name: Check Markdown links | ||
uses: gaurav-nelson/github-action-markdown-link-check@v1 |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.