From 29ef67bd8a937fafabcfde10cbb69c980d9243a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dan=20Michael=20O=2E=20Hegg=C3=B8?= <danmichaelo@gmail.com>
Date: Sun, 21 Aug 2016 22:57:43 +0200
Subject: [PATCH] Add info about generating documentation to readme

---
 README.rst | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.rst b/README.rst
index d99a912..62e2252 100644
--- a/README.rst
+++ b/README.rst
@@ -99,6 +99,21 @@ can use `Tox <https://testrun.org/tox/latest/>`_:
     $ pip install tox
     $ tox
 
+*Documentation* consists of both a manually compiled user guide (under
+``docs/user``) and a reference guide generated from the docstrings using
+Sphinx autodoc with the napoleon extension. Documentation is built automatically
+on `ReadTheDocs`_ after each commit. To build documentation locally for testing:
+
+.. code-block:: console
+
+  $ cd docs
+  $ make html
+
+When writing docstrings, try to adher to the `Google style`_.
+
+.. _Google style: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+.. _ReadTheDocs: https://mwclient.readthedocs.io/
+
 Implementation notes
 --------------------
 
-- 
GitLab