Skip to content

Commit 916eef6

Browse files
committed
Added info on use as pre-commit hook
1 parent ffb95c8 commit 916eef6

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

README.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,18 @@ Code Description
150150
============== =====================================================================
151151
SXL001 Double backticked variable should be a link to Python documentation.
152152
============== =====================================================================
153+
154+
Use as a pre-commit hook
155+
--------------------------
156+
157+
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
158+
159+
Sample `.pre-commit-config.yaml`:
160+
161+
```yaml
162+
- repo: https://gitlab.com/pycqa/flake8
163+
rev: 3.8.1
164+
hooks:
165+
- id: flake8
166+
additional_dependencies: [flake8-sphinx-links==0.0.4]
167+
```

doc-source/index.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,6 +149,23 @@ Installation
149149

150150
.. end installation
151151
152+
153+
Use as a pre-commit hook
154+
--------------------------
155+
156+
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
157+
158+
Sample `.pre-commit-config.yaml`:
159+
160+
```yaml
161+
- repo: https://gitlab.com/pycqa/flake8
162+
rev: 3.8.1
163+
hooks:
164+
- id: flake8
165+
additional_dependencies: [flake8-sphinx-links==0.0.4]
166+
```
167+
168+
152169
.. toctree::
153170
:hidden:
154171

0 commit comments

Comments
 (0)