mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-15 00:44:44 +00:00
Nest plugin development docs
This commit is contained in:
parent
36bb148ad5
commit
1d3b254814
4 changed files with 25 additions and 6 deletions
|
|
@ -1,3 +1,5 @@
|
||||||
|
.. _formatting-plugins:
|
||||||
|
|
||||||
===========================================
|
===========================================
|
||||||
Developing a Formatting Plugin for Flake8
|
Developing a Formatting Plugin for Flake8
|
||||||
===========================================
|
===========================================
|
||||||
|
|
|
||||||
17
docs/source/dev/index.rst
Normal file
17
docs/source/dev/index.rst
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
============================
|
||||||
|
Writing Plugins for Flake8
|
||||||
|
============================
|
||||||
|
|
||||||
|
Since Flake8 2.0, the Flake8 tool has allowed for extensions and custom
|
||||||
|
plugins. In Flake8 3.0, we're expanding that ability to customize and
|
||||||
|
extend **and** we're attempting to thoroughly document it too. Some of the
|
||||||
|
documentation in this section will reference third-party documentation
|
||||||
|
in order to reduce duplication and to point you, the developer, towards
|
||||||
|
the authoritative documentation for those pieces.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
plugin_parameters
|
||||||
|
registering_plugins
|
||||||
|
formatters
|
||||||
|
|
@ -1,6 +1,8 @@
|
||||||
====================================
|
.. _plugin-parameters:
|
||||||
Receiving Information For A Plugin
|
|
||||||
====================================
|
==========================================
|
||||||
|
Receiving Information For A Check Plugin
|
||||||
|
==========================================
|
||||||
|
|
||||||
Plugins to Flake8 have a great deal of information that they can request from
|
Plugins to Flake8 have a great deal of information that they can request from
|
||||||
a :class:`~flake8.processor.FileProcessor` instance. Historically, Flake8 has
|
a :class:`~flake8.processor.FileProcessor` instance. Historically, Flake8 has
|
||||||
|
|
|
||||||
|
|
@ -18,9 +18,7 @@ Plugin Developer Guide
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
dev/formatters
|
dev/index
|
||||||
dev/plugin_parameters
|
|
||||||
dev/registering_plugins
|
|
||||||
|
|
||||||
Developer Guide
|
Developer Guide
|
||||||
---------------
|
---------------
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue