flake8/docs/source/internal/index.rst
Ian Cordasco 7fe5b359f7
Add high-level overview of how things fit together
There are now a lot of moving parts in Flake8. It can't help to give new
developers a high-level overview of how they all fit together to make
Flake8. =)
2016-06-26 20:28:24 -05:00

27 lines
774 B
ReStructuredText

==============================
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
contributing
writing-documentation
releases
start-to-finish
checker
cli
formatters
option_handling
plugin_handling
utils