summaryrefslogtreecommitdiff
path: root/doc/develop.rst
diff options
context:
space:
mode:
authorLars-Dominik Braun <lars@6xq.net>2019-07-06 15:31:53 +0200
committerLars-Dominik Braun <lars@6xq.net>2019-07-06 15:31:53 +0200
commit46d6c7f296e8b29db307cd180f3743e36b29ffe3 (patch)
treeb1758c501904f6d826e719dc24564adaf701238b /doc/develop.rst
parenta8a0de408cbb00c0dbb19acd0d26eef53f778ec0 (diff)
downloadcrocoite-46d6c7f296e8b29db307cd180f3743e36b29ffe3.tar.gz
crocoite-46d6c7f296e8b29db307cd180f3743e36b29ffe3.tar.bz2
crocoite-46d6c7f296e8b29db307cd180f3743e36b29ffe3.zip
Improve documentation
Diffstat (limited to 'doc/develop.rst')
-rw-r--r--doc/develop.rst16
1 files changed, 7 insertions, 9 deletions
diff --git a/doc/develop.rst b/doc/develop.rst
index 8a8e8bd..801ab21 100644
--- a/doc/develop.rst
+++ b/doc/develop.rst
@@ -1,19 +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
+Generally crocoite provides reasonable defaults for Google Chrome via
+:py:mod:`crocoite.devtools`. 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
+and then passing the option :option:`--browser=http://localhost:9222` to
+:program:`crocoite-single`. This allows human intervention through the
+browser’s builtin console.
Release guide
^^^^^^^^^^^^^
@@ -34,7 +32,7 @@ a new version to pypi_::
gpg --detach-sign --armor dist/*.tar.gz
twine upload dist/*
-Then update the documentation using ``sphing-doc`` and upload it as well.
+Then update the documentation using :program:`sphing-doc` and upload it as well.
.. _semantic versioning: https://semver.org/spec/v2.0.0.html
.. _pypi: https://pypi.org