Update README.rst with instruction how to build documentation.

Signed-off-by: Tomasz Tyzenhauz <[email protected]>
nrfconnect · Jul 7, 2022 · 9a0cdf8 · 9a0cdf8
1 parent eadb11f
commit 9a0cdf8
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.rst b/README.rst
@@ -76,8 +76,19 @@ Documentation for this project is placed in the ``doc`` directory.
    :class: highlight
 
    cd doc
+   pip install -r requirements-doc.txt
    make html
-   xdg-open build/html/index.html
+
+
+  or run script which builds documentation in docker container (nothing except docker engine is required):
+
+
+  .. parsed-literal::
+   :class: highlight
+
+   cd doc
+   ./build_doc_in_docker.sh
+
 
   The documentation will be generated in ``doc/build/html``.
   To view the documentation, open ``doc/build/html/index.html`` in a web browser.

diff --git a/doc/build_doc_in_docker.sh b/doc/build_doc_in_docker.sh
@@ -35,4 +35,4 @@ elif [ $# -eq 1 ]; then
     pip install -r requirements-doc.txt
     sphinx-build -M html . build
     chown -R $USER_ID:$GRP_ID build
-fi
+fi