From 12cc2fbe15533c673b12bd3cf6bed2a5c8b8a46e Mon Sep 17 00:00:00 2001 From: Maxime Beauchemin Date: Sat, 25 Aug 2018 16:31:03 -0700 Subject: [PATCH] [docs] note as to how to build and view the docs --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a20006354e..d15c88dcd3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -38,6 +38,9 @@ whether as part of the official Superset docs, in docstrings, `docs/*.rst` or even on the web as blog posts or articles. +To build the docs, simply run ``./build.sh`` from the ``docs/`` folder. +The rendered docs are accessible at `http://localhost:{PORT}/static/assets/docs/faq.html`. + ### Submit Feedback The best way to send feedback is to file an issue on GitHub.