summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/user/index.rst1
-rw-r--r--docs/source/user/python-api.rst11
2 files changed, 12 insertions, 0 deletions
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
index 5e7503f..2ed779e 100644
--- a/docs/source/user/index.rst
+++ b/docs/source/user/index.rst
@@ -24,6 +24,7 @@ This guide will cover all of these and the nuances for using Flake8.
configuration
options
ignoring-errors
+ python-api
.. config files
.. command-line tutorial
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: