Documentation for --pdb, refs #962

simonw · Sep 11, 2020 · 77521c6 · 77521c6
1 parent ca5c405
commit 77521c6
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -86,6 +86,17 @@ Then run Datasette like this::
 
     datasette fixtures.db -m fixtures-metadata.json --plugins-dir=fixtures-plugins/
 
+.. _contributing_debugging:
+
+Debugging
+---------
+
+Any errors that occur while Datasette is running while display a stack trace on the console.
+
+You can tell Datasette to open an interactive ``pdb`` debugger session if an error occurs using the ``--pdb`` option::
+
+    datasette --pdb fixtures.db
+
 .. _contributing_documentation:
 
 Editing and building the documentation