summaryrefslogtreecommitdiff
path: root/doc/develop.rst
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-03-22 12:25:22 +0100
committerLars-Dominik Braun <lars@6xq.net>2019-03-22 12:25:22 +0100
commitcb1d9e40ce99fd6c5d045e13e10619c8a24f12e8 (patch)
treefa88eb989159de79c5769497546da9792a7a6045 /doc/develop.rst
parent9f535348ef2740d0d88096c330bbc2618ae5c4c5 (diff)
downloadcrocoite-cb1d9e40ce99fd6c5d045e13e10619c8a24f12e8.tar.gz
crocoite-cb1d9e40ce99fd6c5d045e13e10619c8a24f12e8.tar.bz2
crocoite-cb1d9e40ce99fd6c5d045e13e10619c8a24f12e8.zip
Move documentation to Sphinx
Diffstat (limited to 'doc/develop.rst')
-rw-r--r--doc/develop.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/develop.rst b/doc/develop.rst
new file mode 100644
index 0000000..0113c92
--- /dev/null
+++ b/doc/develop.rst
@@ -0,0 +1,17 @@
+Development
+-----------
+
+Generally crocoite provides reasonable defaults for Google Chrome via its
+`devtools module`_. When debugging this software it might be necessary to open
+a non-headless instance of the browser by running
+
+.. code:: bash
+
+ google-chrome-stable --remote-debugging-port=9222 --auto-open-devtools-for-tabs
+
+and then passing the option ``--browser=http://localhost:9222`` to
+``crocoite-grab``. This allows human intervention through the browser’s builtin
+console.
+
+.. _devtools module: crocoite/devtools.py
+