Skip to content

Commit

Permalink
Add sphinx-lint checks to CI (#1327)
Browse files Browse the repository at this point in the history
* lint

* Ignore ``GenIncProcessModel``

* slashes
  • Loading branch information
AA-Turner authored Jul 28, 2023
1 parent b50d028 commit 188823c
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,3 +74,25 @@ jobs:
--force
https://x-access-token:${{ github.token }}@github.com/${{ github.repository }}
`git subtree split --prefix HARK-docs/html gh-pages`:refs/heads/gh-pages
lint:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install --upgrade sphinx-lint
- name: Lint documentation with sphinx-lint
run: >
sphinx-lint
--ignore Documentation/example_notebooks/GenIncProcessModel.py
--enable all
--max-line-length 85
README.md
Documentation/

0 comments on commit 188823c

Please sign in to comment.