Mention documentation in README.rst

Former-commit-id: c2bb09432c1e78a324464243951c7e75fc8fd734
2019-02-25 09:23:12 +02:00 · 2019-02-25 09:23:12 +02:00 · ee73a8f029
parent 99b20b7d2e
commit ee73a8f029
1 changed files with 12 additions and 0 deletions
--- 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``.