From 9a0cdf8b52f25f5bae8751e58633b99ad8d8a218 Mon Sep 17 00:00:00 2001 From: Tomasz Tyzenhauz Date: Thu, 7 Jul 2022 14:23:57 +0200 Subject: [PATCH] Update README.rst with instruction how to build documentation. Signed-off-by: Tomasz Tyzenhauz --- README.rst | 13 ++++++++++++- doc/build_doc_in_docker.sh | 2 +- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index b2fc2f83a4..1d2aeb0387 100644 --- 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 index 66f4e6bcf4..44b4d6c28f 100755 --- 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 \ No newline at end of file +fi