From 0f03e3091d6197689f8fc7a283a2f7ebc901a548 Mon Sep 17 00:00:00 2001 From: Camila Date: Tue, 8 Sep 2020 15:09:31 +0200 Subject: [PATCH] Add README with instructions on how to build the documentation. Signed-off-by: Camila --- doc/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 000000000..9add0661a --- /dev/null +++ b/doc/README.md @@ -0,0 +1,17 @@ +# Desktop client documentation + +- The main nextcloud Documentation is found at https://github.com/nextcloud/documentation +- The rst files from the current stable branch will be parsed with sphinx to be used at https://docs.nextcloud.com/desktop/3.0/ + +## How to build the documentation + +- After installing [sphinx](https://www.sphinx-doc.org) you can run: + +``` +$ git clone https://github.com/nextcloud/desktop.git +$ cd desktop +$ cd docs +$ sphinx-build -b html -D html_theme='nextcloud_com' -d _build/doctrees . _build/html/com +``` + +The documentation html files will be at ```desktop/docs/_build/html/com```.