From ee73a8f0293eee0762818271ae6d239911eda318 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Ne=C4=8Dada?= Date: Mon, 25 Feb 2019 09:23:12 +0200 Subject: [PATCH] Mention documentation in README.rst Former-commit-id: c2bb09432c1e78a324464243951c7e75fc8fd734 --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.rst b/README.rst index 9d998fc..449c06b 100644 --- a/README.rst +++ b/README.rst @@ -30,3 +30,15 @@ Easiest installation ever pip3 install --user git+https://github.com/moble/spherical_functions.git python3 setup.py install --user + + +Documentation +============= + +Documentation of QPMS is a work in progress. Most of the newer code +is documented using doxygen comments. To build the documentation, just run:: + + doxygen + +in the root directory; the documentation will then be found in +``docs/index.html``.