pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-11 23:34:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Nest internal docs

Browse source
This commit is contained in:
Ian Cordasco 2016-05-18 22:16:53 -05:00
parent 1d3b254814
commit e1fe99a90b
2 changed files with 24 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/source/index.rst
View file

@ -26,12 +26,7 @@ Developer Guide
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
internal/checker internal/index
internal/cli
internal/formatters
internal/option_handling
internal/plugin_handling
internal/utils
Indices and tables Indices and tables
================== ==================

23
docs/source/internal/index.rst Normal file
View file

@ -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