diff options
| author | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-05-18 22:16:53 -0500 |
|---|---|---|
| committer | Ian Cordasco <graffatcolmingov@gmail.com> | 2016-05-18 22:16:53 -0500 |
| commit | e1fe99a90b5979cae7419b28c3ec4d7c6067e955 (patch) | |
| tree | b01595c0d60087d4db3290b40e45e2963c9df517 /docs/source/internal | |
| parent | 1d3b2548144febc638ba4d219717ef0896320959 (diff) | |
| download | flake8-e1fe99a90b5979cae7419b28c3ec4d7c6067e955.tar.gz | |
Nest internal docs
Diffstat (limited to 'docs/source/internal')
| -rw-r--r-- | docs/source/internal/index.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/source/internal/index.rst b/docs/source/internal/index.rst new file mode 100644 index 0000000..4220fe9 --- /dev/null +++ b/docs/source/internal/index.rst @@ -0,0 +1,23 @@ +============================== + Exploring Flake8's Internals +============================== + +While writing Flake8 3.0, the developers attempted to capture some reasoning +and decision information in internal documentation meant for future developers +and maintaners. Most of this information is unnecessary for users and plugin +developers. Some of it, however, is linked to from the plugin development +documentation. + +Keep in mind that not everything will be here and you may need to help pull +information out of the developers' heads and into these documents. Please +pull gently. + +.. toctree:: + :maxdepth: 2 + + checker + cli + formatters + option_handling + plugin_handling + utils |