From 1d3b2548144febc638ba4d219717ef0896320959 Mon Sep 17 00:00:00 2001 From: Ian Cordasco Date: Wed, 18 May 2016 22:10:42 -0500 Subject: [PATCH] Nest plugin development docs --- docs/source/dev/formatters.rst | 2 ++ docs/source/dev/index.rst | 17 +++++++++++++++++ docs/source/dev/plugin_parameters.rst | 8 +++++--- docs/source/index.rst | 4 +--- 4 files changed, 25 insertions(+), 6 deletions(-) create mode 100644 docs/source/dev/index.rst 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 diff --git a/docs/source/index.rst b/docs/source/index.rst index e1b4165..563e33d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,9 +18,7 @@ Plugin Developer Guide .. toctree:: :maxdepth: 2 - dev/formatters - dev/plugin_parameters - dev/registering_plugins + dev/index Developer Guide ---------------