From c5796b993fe4f509a4ae89cc7b2ab4c10f0f0c45 Mon Sep 17 00:00:00 2001 From: "Lars K.W. Gohlke" Date: Wed, 11 May 2016 10:47:49 +0000 Subject: [PATCH] readme: Getting started building docs locally GitHub-Pull-Request: https://github.com/syncthing/docs/pull/164 --- README.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.rst b/README.rst index e71ee1063..9db8c44a3 100644 --- a/README.rst +++ b/README.rst @@ -16,6 +16,15 @@ documentation team and perform edits without requiring approval. In the long run, learning to use Git_ and running Sphinx_ on your computer is beneficial. +First steps to run is locally + :: + + git clone https://github.com/syncthing/docs.git + pip install -U Sphinx + cd docs + make html + # open _build/html/index.html + Structure ---------