Commit graph

76 commits

Author SHA1 Message Date
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
25df2df55c Add installation and quickstart to docs start page 2016-05-18 22:28:32 -05:00
Ian Cordasco
e1fe99a90b Nest internal docs 2016-05-18 22:16:53 -05:00
Ian Cordasco
1d3b254814 Nest plugin development docs 2016-05-18 22:10:42 -05:00
Ian Cordasco
36bb148ad5 Add documentation for receiving parsed options 2016-05-17 20:19:02 -05:00
Ian Cordasco
9ada68118d Finish writing about registering plugin options 2016-05-17 20:01:49 -05:00
Ian Cordasco
6b9b4a5aca Add more information about providing information to plugins 2016-05-16 20:53:04 -05:00
Ian Cordasco
72833b629a Start adding documentation about developing plugins 2016-05-16 20:15:14 -05:00
Ian Cordasco
c689781166 Update title 2016-05-16 15:58:59 -05:00
Ian Cordasco
99030223a4 Trim trailing whitespace 2016-05-16 08:17:51 -05:00
Ian Cordasco
89762b9dd1 Document flake8.checker and flake8.processor 2016-05-14 19:35:58 -05:00
Ian Cordasco
ccadc09a0e Add documentation about how we handle pep8 as a plugin 2016-05-10 20:12:17 -05:00
Ian Cordasco
adaa47730e Comment html_static_path in sphinx config 2016-05-10 17:26:11 -05:00
Ian Cordasco
414922d08e Add documentation around the cli 2016-05-08 14:02:40 -05:00
Ian Cordasco
55cc996368 Move old documentation out of the way 2016-03-17 15:10:35 -05:00
Ian Cordasco
867727f304 Merge remote-tracking branch 'rewrite/master' into proposed/3.0 2016-03-15 16:00:19 -05:00
Ian Cordasco
a4e984dbd2 Add and fix documentation
- Add more documentation around utils functions
- Fix documentation about default formatting plugins
- Add extra documentation of filenames_from predicate parameter
- Add test for the default parameter of flake8.utils.fnmatch
2016-02-25 09:06:50 -06:00
Ian Cordasco
54ad972e56 Add doc8 linting 2016-02-23 14:42:09 -06:00
Ian Cordasco
c20793b49c Add internal documentation around default formatters 2016-02-10 22:44:27 -06:00
Ian Cordasco
f824cbae93 Update docs index and tox env 2016-02-07 19:54:12 -06:00
Ian Cordasco
56976671d0 Fix entry-point names and example usage 2016-02-07 09:39:19 -06:00
Ian Cordasco
7828b63002 Finish developer documentation around formatter plugins 2016-02-06 15:18:41 -06:00
Ian Cordasco
fe1b628c0f Add documentation around plugins and formatters 2016-02-06 14:36:44 -06:00
Ian Cordasco
a4e051614f Document flake8.utils 2016-02-03 23:11:45 -06:00
Ian Cordasco
4dc1cc386d Add documentation around plugin notifications and pyflakes 2016-02-01 20:33:18 -06:00
Ian Cordasco
5dc7440a2b Start documenting our Trie implementation 2016-02-01 20:09:15 -06:00
Ian Cordasco
51d11d1a30 Note inspiration 2016-02-01 00:00:29 -06:00
Ian Cordasco
f4f68b6442 Document our plugin handling 2016-01-31 23:59:53 -06:00
Ian Cordasco
4cf48b9b77 Add documentation about option aggregation
Add logging around default ignore lists
2016-01-27 21:32:40 -06:00
Ian Cordasco
f59152cc01 Start documenting configuration parsing 2016-01-26 08:40:56 -06:00
Ian Cordasco
938d2c450a Switch to the RTD theme 2016-01-26 08:40:45 -06:00
Ian Cordasco
7898b5c12e Add documentation around Option Management 2016-01-25 22:06:14 -06:00
Ian Cordasco
6590fab3f2 Move docs directories into docs/source 2016-01-25 21:15:04 -06:00
Ian Cordasco
f2ca91372a Start structuring documentation 2016-01-25 20:40:33 -06:00
Ian Cordasco
11be73dbbb Note that we need at least Sphinx 1.3
Exclude sphinx conf.py from flake8
2016-01-19 07:27:39 -06:00
Ian Cordasco
e66fc2efa8 Start creating documentation 2016-01-19 07:19:16 -06:00
Jason Myers
b0a6bada5c Switching to --enable-extensions instead of --select
Signed-off-by: Jason Myers <jason@jasonamyers.com>
2015-12-20 11:23:41 -06:00
Jason Myers
a08a65b982 Adding docs for off by default
This adds documentation for the off_by_default option for extensions,
which was added in MR !14.

Signed-off-by: Jason Myers <jason@jasonamyers.com>
2015-12-19 15:48:32 -06:00
Andrew Widdersheim
828c69ea27 Fix per-project configuration file list 2015-12-09 08:54:51 -05:00
Luke Plant
b8457ebb24 Added link to flake8-respect-noqa extension. 2015-09-07 15:13:30 +00:00
Javier Domingo Cansino
7b7e1da0f4 docs: Adding flake8-import-order plugin to the list of available plugins 2015-08-11 08:32:43 +02:00
Michele Lacchia
f428a9fee3 Add radon to Existing Extensions section 2015-07-10 06:29:06 +00:00
Tyrel Souza
181cffda7f Add a note about Windows .flake8 config location 2015-04-30 16:23:18 -04:00
Ian Cordasco
bc18d8e2d1 Use the default ReadTheDocs theme 2015-02-22 22:37:13 -06:00
Ian Cordasco
ba344c8ded Refactor some bits of flake8.hooks 2015-02-22 22:29:13 -06:00
Oleg Broytman
836d66a11f Document configuration file settings 2015-02-16 07:32:17 +03:00
Joseph Kahn
51955f9664 got rid of extra line added by accident. 2014-09-13 12:13:04 -05:00