summaryrefslogtreecommitdiff
path: root/docs/source/dev
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-05-18 22:10:42 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-05-18 22:10:42 -0500
commit1d3b2548144febc638ba4d219717ef0896320959 (patch)
tree084eb5334fa54f37335a2fc37c2368e0a79b04bc /docs/source/dev
parent36bb148ad542b99816de771739f6d2ad25343245 (diff)
downloadflake8-1d3b2548144febc638ba4d219717ef0896320959.tar.gz
Nest plugin development docs
Diffstat (limited to 'docs/source/dev')
-rw-r--r--docs/source/dev/formatters.rst2
-rw-r--r--docs/source/dev/index.rst17
-rw-r--r--docs/source/dev/plugin_parameters.rst8
3 files changed, 24 insertions, 3 deletions
diff --git a/docs/source/dev/formatters.rst b/docs/source/dev/formatters.rst
index 0b37abd..5307e75 100644
--- a/docs/source/dev/formatters.rst
+++ b/docs/source/dev/formatters.rst
@@ -1,3 +1,5 @@
+.. _formatting-plugins:
+
===========================================
Developing a Formatting Plugin for Flake8
===========================================
diff --git a/docs/source/dev/index.rst b/docs/source/dev/index.rst
new file mode 100644
index 0000000..43f01c1
--- /dev/null
+++ b/docs/source/dev/index.rst
@@ -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
diff --git a/docs/source/dev/plugin_parameters.rst b/docs/source/dev/plugin_parameters.rst
index 39db95e..9b074ec 100644
--- a/docs/source/dev/plugin_parameters.rst
+++ b/docs/source/dev/plugin_parameters.rst
@@ -1,6 +1,8 @@
-====================================
- Receiving Information For A Plugin
-====================================
+.. _plugin-parameters:
+
+==========================================
+ Receiving Information For A Check Plugin
+==========================================
Plugins to Flake8 have a great deal of information that they can request from
a :class:`~flake8.processor.FileProcessor` instance. Historically, Flake8 has