Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
adam.huang
Arm Trusted Firmware
Commits
894eb3ee
Commit
894eb3ee
authored
Jul 28, 2020
by
Sandrine Bailleux
Committed by
TrustedFirmware Code Review
Jul 28, 2020
Browse files
Merge "doc: use docker to build documentation" into integration
parents
ffef797d
7be2b983
Changes
1
Hide whitespace changes
Inline
Side-by-side
docs/getting_started/docs-build.rst
View file @
894eb3ee
...
@@ -67,7 +67,7 @@ Output from the build process will be placed in:
...
@@ -67,7 +67,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``
We also support building documentation in other formats. From the ``docs``
directory of the project, run the following command to see the supported
directory of the project, run the following command to see the supported
...
@@ -79,6 +79,31 @@ top-level Makefile for |TF-A| itself.
...
@@ -79,6 +79,31 @@ top-level Makefile for |TF-A| itself.
make help
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) 2019, Arm Limited. All rights reserved.*
*Copyright (c) 2019, Arm Limited. All rights reserved.*
...
@@ -86,3 +111,5 @@ top-level Makefile for |TF-A| itself.
...
@@ -86,3 +111,5 @@ top-level Makefile for |TF-A| itself.
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _Sphinx: http://www.sphinx-doc.org/en/master/
.. _pip homepage: https://pip.pypa.io/en/stable/
.. _pip homepage: https://pip.pypa.io/en/stable/
.. _Dia: https://wiki.gnome.org/Apps/Dia
.. _Dia: https://wiki.gnome.org/Apps/Dia
.. _docker: https://www.docker.com/
.. _docker hub: https://hub.docker.com/repository/docker/sphinxdoc/sphinx
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment