77 commits

Author	SHA1	Message	Date
Ian Cordasco	cae943bd44	Add missing - to sub-directories	2016-06-22 19:27:23 -05:00
Ian Cordasco	1de5da8a7f	Add more definitions to glossary	2016-06-22 19:27:10 -05:00
Ian Cordasco	478d5620d8	Correct example register_options method	2016-06-22 19:13:20 -05:00
Ian Cordasco	88d1dd280a	Start a glossary of terms	2016-06-22 14:34:14 -05:00
Ian Cordasco	601696d564	Trim whitespace from cross-compat plugin docs	2016-06-22 10:07:16 -05:00
Ian Cordasco	6c0d900a38	Write plugin cross-compatibility documentation	2016-06-22 08:40:53 -05:00
Ian Cordasco	9526e061a7	Add more detail about types of releases	2016-06-22 08:10:07 -05:00
Ian Cordasco	60b67f4ef3	Trim trailing whitespace ... I need to get better at following my own contrib documentation	2016-06-22 08:05:47 -05:00
Ian Cordasco	f3cd7ee6fb	Update FAQ to be a bit clearer	2016-06-21 07:36:40 -05:00
Ian Cordasco	a4c1edb03e	Add FAQ	2016-06-20 20:54:31 -05:00
Ian Cordasco	b67d1d633e	Add documentation about release versioning and process	2016-06-20 20:53:47 -05:00
Ian Cordasco	590e15cb4c	Trim trailing whitespace in docs	2016-06-20 13:42:48 -05:00
Ian Cordasco	3e8bbc50dc	Add documentation ... for writing documentation	2016-06-20 09:26:01 -05:00
Ian Cordasco	41277ff965	Use |Flake8| consistently throughout documentation	2016-06-20 08:13:50 -05:00
Ian Cordasco	57ac6ab699	Add |Flake8| substitution to the epilog ... The rst_epilog config value in Sphinx allows you to maintain a global list of replaces or includes that are appended to the text of each document in your documentation. This allows us to use |Flake8| everywhere without redefining the replace in every document.	2016-06-20 08:04:33 -05:00
Ian Cordasco	16f58005bf	Add --benchmark option documentation	2016-06-19 20:41:19 -05:00
Cea Stapleton	330fdb5b56	Grammar and clarity improvements.	2016-06-19 14:06:26 -05:00
Ian Cordasco	1de71fbe89	Set a default value for --select ... This allows us to add --append-to-select and --append-to-ignore at a later date that will work as expected and in a consistent manner.	2016-06-16 08:27:28 -05:00
Ian Cordasco	b1f039a476	Add information about new --verbose behaviour	2016-06-15 09:20:26 -05:00
Ian Cordasco	25502f6ade	Add note about # noqa: <errors>	2016-06-15 07:48:46 -05:00
Ian Cordasco	29419b0ac3	Start a changelog entry for 3.0.0	2016-06-14 20:48:04 -05:00
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	18d6e6264c	Revert silliness around setting choices for --format ... If we restrict the user's ability to specify a format string, we break existing workflows.	2016-06-14 20:04:52 -05:00
Ian Cordasco	472e7c9589	Add release notes portion of documentation	2016-06-14 09:58:24 -05:00
Ian Cordasco	706520828d	Fix documentation build	2016-06-14 09:57:49 -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	55f10211a3	Check for version of Python on Windows ... Certain versions of Python on Windows are capable of using multiprocessing safely and correctly. Instead of completely disabling multiprocessing on Windows, this allows us to check for safe versions. This also updates our internal utility documentation to add missing functions and add a strongly worded warning about the API of those functions.	2016-06-07 19:56:41 -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	e93091575c	Remove last trailing whitespace	2016-06-04 15:23:31 -05:00
Ian Cordasco	0fbfeb919a	Trim trailing whitespace in contributing docs	2016-06-04 15:19:11 -05:00
Ian Cordasco	0a418f8d1e	Refactor docs requirements into file for RTD	2016-06-04 14:26:37 -05:00
Ian Cordasco	eb9fcac064	Add contributing documentation	2016-06-04 14:18:44 -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	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