| Robert Rostohar | 85056ab | 2021-01-25 17:01:11 +0100 | [diff] [blame] | 1 | #!/bin/bash |
| 2 | # Copyright (c) 2020, Arm Limited. All rights reserved. |
| 3 | # SPDX-License-Identifier: BSD-3-Clause |
| 4 | # Generate TF-M documentation |
| 5 | |
| 6 | # Make sure that path to PlantUML JAR is exported before running this script |
| 7 | #export PLANTUML_JAR_PATH=/c/plantuml/plantuml.jar |
| 8 | |
| 9 | # Update link to reference manual |
| 10 | sed -i 's|https://ci.trustedfirmware.org/job/tf-m-build-docs/lastSuccessfulBuild/artifact/trusted-firmware-m/build/install/doc/|../|' ./trusted-firmware-m/docs/index.rst |
| 11 | |
| 12 | # Create directory for reference manual |
| 13 | mkdir -p ./trusted-firmware-m/docs/reference_manual |
| 14 | |
| 15 | pushd ./trusted-firmware-m/build_docs |
| 16 | |
| 17 | # Create empty environment variable |
| 18 | echo "cmake_env = None" > tfm_env.py |
| 19 | |
| 20 | # Generate reference and user manual |
| Robert Rostohar | c25fc5f | 2021-02-18 14:59:06 +0100 | [diff] [blame] | 21 | sphinx-build . user_guide |
| Robert Rostohar | 85056ab | 2021-01-25 17:01:11 +0100 | [diff] [blame] | 22 | |
| 23 | # Move generated documentation |
| 24 | mv reference_manual/html ../docs/reference_manual |
| 25 | mv user_guide ../docs |
| 26 | |
| 27 | popd |
| 28 | |
| 29 | # Delete documentation tools |
| 30 | rm -rf ./trusted-firmware-m/tools/documentation |
| 31 | |
| 32 | # Delete documentation sources |
| 33 | find ./trusted-firmware-m -name *.rst -delete |
| 34 | find ./trusted-firmware-m -name *.dox -delete |
| 35 | find ./tf-m-tests -name *.rst -delete |
| 36 | find ./tf-m-tests -name *.dox -delete |