| Anas Nashif | df5d7d7 | 2017-11-07 20:05:56 -0500 | [diff] [blame] | 1 | # |
| David B. Kinder | d34c116 | 2019-02-05 09:53:16 -0800 | [diff] [blame] | 2 | # Top level makefile for documentation build |
| Anas Nashif | df5d7d7 | 2017-11-07 20:05:56 -0500 | [diff] [blame] | 3 | # |
| 4 | |
| David B. Kinder | 41bc9cf | 2018-09-04 13:03:50 -0700 | [diff] [blame] | 5 | ifndef ZEPHYR_BASE |
| 6 | $(error The ZEPHYR_BASE environment variable must be set) |
| 7 | endif |
| 8 | |
| Carles Cufi | 7480f17 | 2018-07-10 13:31:18 +0200 | [diff] [blame] | 9 | BUILDDIR ?= doc/_build |
| Carles Cufi | b3d2de7 | 2018-07-13 11:55:54 +0200 | [diff] [blame] | 10 | DOC_TAG ?= development |
| 11 | SPHINXOPTS ?= -q |
| Anas Nashif | df5d7d7 | 2017-11-07 20:05:56 -0500 | [diff] [blame] | 12 | |
| 13 | # Documentation targets |
| 14 | # --------------------------------------------------------------------------- |
| David B. Kinder | d34c116 | 2019-02-05 09:53:16 -0800 | [diff] [blame] | 15 | clean: |
| 16 | rm -rf ${BUILDDIR} |
| 17 | |
| Anas Nashif | df5d7d7 | 2017-11-07 20:05:56 -0500 | [diff] [blame] | 18 | htmldocs: |
| Carles Cufi | f84caef | 2018-07-19 13:47:45 +0200 | [diff] [blame] | 19 | mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs |
| Daniel Leung | 1d88e86 | 2018-09-10 17:27:13 -0700 | [diff] [blame] | 20 | |
| Anas Nashif | 940a931 | 2019-01-21 13:58:05 -0500 | [diff] [blame] | 21 | htmldocs-fast: |
| 22 | mkdir -p ${BUILDDIR} && cmake -GNinja -DKCONFIG_TURBO_MODE=1 -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} htmldocs |
| 23 | |
| Daniel Leung | 1d88e86 | 2018-09-10 17:27:13 -0700 | [diff] [blame] | 24 | pdfdocs: |
| 25 | mkdir -p ${BUILDDIR} && cmake -GNinja -DDOC_TAG=${DOC_TAG} -DSPHINXOPTS=${SPHINXOPTS} -B${BUILDDIR} -Hdoc/ && ninja -C ${BUILDDIR} pdfdocs |
