Commit graph

16 commits

Author SHA1 Message Date
Ian Cordasco
e2ef07fe80
Copied one too many lines from template 2016-06-14 20:47:35 -05:00
Ian Cordasco
8bb3048775
Add documentation for --install-hook 2016-06-14 20:43:00 -05:00
Ian Cordasco
8a18cfa4a3
Add documentation around specifying a format string 2016-06-14 20:10:09 -05:00
Ian Cordasco
107f595d13
Add flake8.api and docs for it
Stub out the primary method people seem to use.
2016-06-08 11:48:36 -05:00
Ian Cordasco
27dbd61f12
Add documentation around ignoring errors 2016-06-07 18:46:24 -05:00
Ian Cordasco
02bcbee245
Add --stdin-display-name to modify report output 2016-06-06 19:46:29 -05:00
Ian Cordasco
33f982b446 Rely on Python 3.4 backport of configparser
Python 2.7's ConfigParser module does not allow for the behaviour we
have documented for config files in Flake8 3.0. To compensate for that,
we add a dependency on the configparser backport on PyPI for Python 2.7
2016-05-30 12:51:31 -05:00
Ian Cordasco
e9ddf7533b Add template in comments for new options
Also ensure that existing documentation is consistent with the template
2016-05-29 21:04:03 -05:00
Ian Cordasco
4c3d176f9a Add a first pass at documenting cli options 2016-05-29 20:56:30 -05:00
Ian Cordasco
89c9ec795e Start adding descriptions of options 2016-05-28 12:20:46 -05:00
Ian Cordasco
466ef2e596 Add example configuration sections to the docs
Add tests to verify our examples do not regress
2016-05-28 12:00:47 -05:00
Ian Cordasco
50d74e3cce Add more to configuration documentation 2016-05-27 11:03:36 -05:00
Ian Cordasco
a7898e0389 Begin adding user-facing documentation
Especially around invocation and configuration
2016-05-26 13:21:25 -05:00
Ian Cordasco
f353a5db90 Add a tiny bit to Usage Guide index 2016-05-18 23:05:09 -05:00
Ian Cordasco
28a97a8499 Add user guide index page 2016-05-18 22:28:44 -05:00
Ian Cordasco
6590fab3f2 Move docs directories into docs/source 2016-01-25 21:15:04 -06:00