aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLeonardo Sandoval <leonardo.sandoval@linaro.org>2020-07-14 10:05:23 -0500
committerLeonardo Sandoval <leonardo.sandoval@linaro.org>2020-07-17 09:49:21 -0500
commit5b5bc209f4fa16ff9efdb3ae2fe97d810463aab3 (patch)
tree2bf110dfeb2b735daa08c18f1ff6cb65af9bd344
parent8499afc44a1642b50fce554d4fdc9356d07d53a0 (diff)
downloadtf-a-tests-5b5bc209f4fa16ff9efdb3ae2fe97d810463aab3.tar.gz
doc: use docker to build documentation
docker (container) is another way to build the documentation and fortunately there is already a docker image (sphinxdoc/sphinx) with sphinx so we can use it to generate the documentation. Change-Id: I33fba6c5e4810e20546559c80a8f2eecabd4c123 Signed-off-by: Leonardo Sandoval <leonardo.sandoval@linaro.org>
-rw-r--r--docs/getting_started/docs-build.rst29
1 files changed, 28 insertions, 1 deletions
diff --git a/docs/getting_started/docs-build.rst b/docs/getting_started/docs-build.rst
index 6a6992b..1b8c1eb 100644
--- a/docs/getting_started/docs-build.rst
+++ b/docs/getting_started/docs-build.rst
@@ -64,7 +64,7 @@ Output from the build process will be placed in:
::
- docs/build/html/
+ docs/build/html
We also support building documentation in other formats. From the ``docs``
directory of the project, run the following command to see the supported
@@ -76,9 +76,36 @@ top-level Makefile for TF-A Tests themselves.
make help
+Building rendered documentation from a container
+------------------------------------------------
+
+There may be cases where you can not either install or upgrade required
+dependencies to generate the documents, so in this case, one way to
+create the documentation is through a docker container. The first step is
+to check if `docker`_ is installed in your host, otherwise check main docker
+page for installation instructions. Once installed, run the following script
+from project root directory
+
+.. code:: shell
+
+ docker run --rm -v $PWD:/TF sphinxdoc/sphinx \
+ bash -c 'cd /TF && \
+ pip3 install plantuml -r ./docs/requirements.txt && make doc'
+
+The above command fetches the ``sphinxdoc/sphinx`` container from `docker
+hub`_, launches the container, installs documentation requirements and finally
+creates the documentation. Once done, exit the container and output from the
+build process will be placed in:
+
+::
+
+ docs/build/html
+
--------------
*Copyright (c) 2020, Arm Limited. All rights reserved.*
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _pip homepage: https://pip.pypa.io/en/stable/
+.. _docker: https://www.docker.com/
+.. _docker hub: https://hub.docker.com/repository/docker/sphinxdoc/sphinx