diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/index.rst | 7 | ||||
| -rw-r--r-- | docs/source/internal/index.rst | 23 |
2 files changed, 24 insertions, 6 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 563e33d..f940e3d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -26,12 +26,7 @@ Developer Guide .. toctree:: :maxdepth: 2 - internal/checker - internal/cli - internal/formatters - internal/option_handling - internal/plugin_handling - internal/utils + internal/index Indices and tables ================== 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 |