summaryrefslogtreecommitdiff
path: root/docs/source/user/python-api.rst
diff options
context:
space:
mode:
authorIan Cordasco <graffatcolmingov@gmail.com>2016-06-08 11:48:36 -0500
committerIan Cordasco <graffatcolmingov@gmail.com>2016-06-08 11:48:36 -0500
commit107f595d13fda6c76ad2ea218359d11209b5d4a4 (patch)
tree6adae27c646235369800ba90dded0f8ac4ba73c1 /docs/source/user/python-api.rst
parente21628ad827c5f687ab0c3b5fc367351dfdfd743 (diff)
downloadflake8-107f595d13fda6c76ad2ea218359d11209b5d4a4.tar.gz
Add flake8.api and docs for it
Stub out the primary method people seem to use.
Diffstat (limited to 'docs/source/user/python-api.rst')
-rw-r--r--docs/source/user/python-api.rst11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/source/user/python-api.rst b/docs/source/user/python-api.rst
new file mode 100644
index 0000000..2e2a16e
--- /dev/null
+++ b/docs/source/user/python-api.rst
@@ -0,0 +1,11 @@
+===================
+ Public Python API
+===================
+
+Flake8 3.0.0 presently does not have a public, stable Python API.
+
+When it does it will be located in :mod:`flake8.api` and that will
+be documented here.
+
+.. automodule:: flake8.api
+ :members: