4310f39bd9
* Update Contributing Docs - Update docs with all new tox hotness - Test running docs build: - `sphinx-build -a -b html -W docs/ docs/_build/` Fixes #1907 * Fix docs/contributing_to_black.md lint * Remove autogenerated copy pasta * Fix review typos + regen automated docs via Running Sphinx v1.8.5
28 lines
510 B
Markdown
28 lines
510 B
Markdown
[//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM README.md"
|
|
|
|
# GitHub Actions
|
|
|
|
Create a file named `.github/workflows/black.yml` inside your repository with:
|
|
|
|
```yaml
|
|
name: Lint
|
|
|
|
on: [push, pull_request]
|
|
|
|
jobs:
|
|
lint:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v2
|
|
- uses: actions/setup-python@v2
|
|
- uses: psf/black@stable
|
|
with:
|
|
black_args: ". --check"
|
|
```
|
|
|
|
## Inputs
|
|
|
|
### `black_args`
|
|
|
|
**optional**: Black input arguments. Defaults to `. --check --diff`.
|