Skip to content

Commit c9a82c8

Browse files
committed
Rearrange documentation
1 parent 2ea2654 commit c9a82c8

File tree

3 files changed

+27
-19
lines changed

3 files changed

+27
-19
lines changed

doc-source/codes.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

doc-source/index.rst

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -139,16 +139,6 @@ Installation
139139
.. end installation
140140
141141
142-
Use as a pre-commit hook
143-
--------------------------
144-
145-
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
146-
147-
Sample ``.pre-commit-config.yaml``:
148-
149-
.. pre-commit:flake8:: 0.3.0
150-
151-
152142
.. toctree::
153143
:hidden:
154144

@@ -158,7 +148,7 @@ Sample ``.pre-commit-config.yaml``:
158148
:maxdepth: 3
159149
:caption: Documentation
160150

161-
codes
151+
usage
162152
api
163153
contributing
164154
Source

doc-source/usage.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
========
2+
Usage
3+
========
4+
5+
This library provides the Flake8 plugin ``flake8-strftime`` which checks for use of platform specific strftime codes.
6+
7+
8+
Flake8 codes
9+
--------------
10+
11+
.. flake8-codes:: flake8_strftime
12+
13+
STRFTIME001
14+
STRFTIME002
15+
16+
17+
18+
Pre-commit hook
19+
----------------
20+
21+
``flake8-strftime`` can also be used as a ``pre-commit`` hook
22+
See `pre-commit <https://github.com/pre-commit/pre-commit>`_ for instructions
23+
24+
Sample ``.pre-commit-config.yaml``:
25+
26+
.. pre-commit:flake8:: 0.3.0

0 commit comments

Comments
 (0)