From daedb4da79b8efddd737affee73433846e79dcb7 Mon Sep 17 00:00:00 2001 From: Matthias Geier Date: Tue, 15 Mar 2016 15:15:33 +0100 Subject: [PATCH] Add more information about building the docs --- CONTRIBUTING.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index cce580842..746a15de2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -157,6 +157,13 @@ To build the HTML docs:: cd docs make html +After that, the generated HTML files will be available at +``build/html/index.html``. + +You can automatically check if all hyperlinks are still valid:: + + make linkcheck + Windows users can find ``make.bat`` in the ``docs`` folder. You should also have a look at the `Project Jupyter Documentation Guide`__.