Switch to sphinx doc #519
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
| # GitHub Action to automate the identification of common misspellings in text files. | |
| # https://github.com/codespell-project/actions-codespell | |
| # https://github.com/codespell-project/codespell | |
| name: codespell | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - master | |
| pull_request: | |
| branches: | |
| - main | |
| - master | |
| permissions: | |
| contents: read # to fetch code (actions/checkout) | |
| jobs: | |
| codespell: | |
| name: Check for spelling errors | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: codespell-project/actions-codespell@v1 # v1.0 | |
| with: | |
| check_filenames: true | |
| skip: .git,deps | |
| ignore_words_file: .codespell-ignore.txt |