| Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 1 | # |
| Chris Kay | 1870c72 | 2024-05-02 17:52:37 +0000 | [diff] [blame] | 2 | # Copyright (c) 2019-2024, Arm Limited. All rights reserved. |
| Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 3 | # |
| 4 | # SPDX-License-Identifier: BSD-3-Clause |
| 5 | # |
| 6 | # Minimal makefile for Sphinx documentation |
| 7 | # |
| 8 | |
| Chris Kay | 1870c72 | 2024-05-02 17:52:37 +0000 | [diff] [blame] | 9 | include ../make_helpers/common.mk |
| 10 | |
| Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 11 | # You can set these variables from the command line. |
| Sandrine Bailleux | 3995080 | 2020-04-17 14:19:20 +0200 | [diff] [blame] | 12 | SPHINXOPTS = -W |
| Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 13 | SPHINXBUILD = sphinx-build |
| 14 | SPHINXPROJ = TrustedFirmware-A |
| 15 | SOURCEDIR = . |
| 16 | BUILDDIR = build |
| 17 | |
| 18 | # Put it first so that "make" without argument is like "make help". |
| 19 | help: |
| Chris Kay | 1870c72 | 2024-05-02 17:52:37 +0000 | [diff] [blame] | 20 | $(q)$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
| Paul Beesley | 22994f7 | 2019-01-23 15:39:39 +0000 | [diff] [blame] | 21 | |
| 22 | .PHONY: help Makefile |
| 23 | |
| 24 | # Catch-all target: route all unknown targets to Sphinx using the new |
| 25 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). |
| Chris Kay | 1870c72 | 2024-05-02 17:52:37 +0000 | [diff] [blame] | 26 | .DEFAULT: Makefile |
| Tamas Ban | 520040c | 2024-09-03 11:38:30 +0200 | [diff] [blame] | 27 | $(if $(host-poetry),$(q)poetry -q install --with=docs) |
| Chris Kay | 1870c72 | 2024-05-02 17:52:37 +0000 | [diff] [blame] | 28 | $(q)$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |