John DeNisco | 2d1a043 | 2018-07-26 16:21:31 -0400 | [diff] [blame] | 1 | # Minimal makefile for Sphinx documentation |
| 2 | # |
Paul Vinciguerra | 340c15c | 2019-11-05 15:34:36 -0500 | [diff] [blame] | 3 | # We support MacOS for docs generation |
| 4 | ifeq ($(shell uname),Darwin) |
| 5 | OS_ID = darwin |
| 6 | endif |
| 7 | |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 8 | # These should be passed in by the root Makefile |
| 9 | WS_ROOT ?= $(CURDIR)/.. |
| 10 | BR ?= $(WS_ROOT)/build-root |
| 11 | DOCS_DIR ?= $(WS_ROOT)/docs |
| 12 | |
| 13 | VENV_DIR ?= $(DOCS_DIR)/venv |
| 14 | SPHINX_SCRIPTS_DIR ?= $(WS_ROOT)/docs/scripts |
| 15 | |
Paul Vinciguerra | 340c15c | 2019-11-05 15:34:36 -0500 | [diff] [blame] | 16 | # Work out the OS if we haven't already |
| 17 | OS_ID ?= $(shell grep '^ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 18 | OS_VERSION ?= $(shell grep '^VERSION_ID=' /etc/os-release | cut -f2- -d= | sed -e 's/\"//g') |
| 19 | PIP_VERSION ?= $(shell grep 'PIP_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2) |
| 20 | PIP_TOOLS_VERSION ?= $(shell grep 'PIP_TOOLS_VERSION=' ${WS_ROOT}/test/Makefile | cut -d'=' -f2) |
| 21 | |
| 22 | PYTHON ?= "python3" |
Paul Vinciguerra | 340c15c | 2019-11-05 15:34:36 -0500 | [diff] [blame] | 23 | |
Paul Vinciguerra | a26f544 | 2020-03-11 13:28:27 -0400 | [diff] [blame] | 24 | DOC_DEB_DEPENDS = enchant |
| 25 | DOC_RPM_DEPENDS = enchant |
John DeNisco | 2d1a043 | 2018-07-26 16:21:31 -0400 | [diff] [blame] | 26 | |
| 27 | # You can set these variables from the command line. |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 28 | SPHINXOPTS = --keep-going -n -W |
| 29 | SPHINXBUILD = sphinx-build |
| 30 | SPHINXPROJ = fdio-vpp |
| 31 | SOURCEDIR = . |
| 32 | BUILDDIR = ${BR}/docs |
| 33 | BUILDDIR_SRC = ${BUILDDIR}/src |
| 34 | BUILDDIR_OUT = ${BUILDDIR}/html |
| 35 | SCRIPTS_DIR = _scripts |
| 36 | |
John DeNisco | 2d1a043 | 2018-07-26 16:21:31 -0400 | [diff] [blame] | 37 | |
| 38 | # Put it first so that "make" without argument is like "make help". |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 39 | .PHONY: help |
John DeNisco | 2d1a043 | 2018-07-26 16:21:31 -0400 | [diff] [blame] | 40 | help: |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 41 | @( \ |
| 42 | . ${VENV_DIR}/bin/activate; \ |
| 43 | $(SPHINXBUILD) --help ;\ |
| 44 | ) |
John DeNisco | 2d1a043 | 2018-07-26 16:21:31 -0400 | [diff] [blame] | 45 | |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 46 | .PHONY: checkdeps |
| 47 | checkdeps: |
Paul Vinciguerra | 340c15c | 2019-11-05 15:34:36 -0500 | [diff] [blame] | 48 | @echo "Checking whether dependencies for Docs are installed..." |
| 49 | ifeq ($(OS_ID),ubuntu) |
| 50 | @set -e; inst=; \ |
| 51 | for i in $(DOC_DEB_DEPENDS); do \ |
| 52 | dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \ |
| 53 | done; \ |
| 54 | if [ "$$inst" ]; then \ |
| 55 | sudo apt-get update; \ |
| 56 | sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \ |
| 57 | fi |
| 58 | else ifneq ("$(wildcard /etc/redhat-release)","") |
| 59 | @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS) |
| 60 | endif |
Nathan Skrzypczak | 9ad39c0 | 2021-08-19 11:38:06 +0200 | [diff] [blame] | 61 | |
| 62 | .PHONY: spell |
| 63 | spell: clean checkdeps venv ${BUILDDIR_SRC} |
| 64 | @( \ |
| 65 | . ${VENV_DIR}/bin/activate; \ |
| 66 | make -C ${SCRIPTS_DIR} generate && \ |
| 67 | $(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ |
| 68 | ) |
| 69 | |
| 70 | .PHONY: venv |
| 71 | venv: |
| 72 | @( \ |
| 73 | if [ ! -d ${VENV_DIR} ]; then \ |
| 74 | ${PYTHON} -m venv ${VENV_DIR}; \ |
| 75 | . ${VENV_DIR}/bin/activate; \ |
| 76 | ${PYTHON} -m pip install pip==${PIP_VERSION}; \ |
| 77 | ${PYTHON} -m pip install pip-tools==${PIP_TOOLS_VERSION}; \ |
| 78 | ${PYTHON} -m pip install -r ${WS_ROOT}/test/requirements-3.txt; \ |
| 79 | fi; \ |
| 80 | ) |
| 81 | |
| 82 | ${BUILDDIR_SRC}: |
| 83 | @mkdir -p ${BUILDDIR_SRC} |
| 84 | @cp -r $(SOURCEDIR) ${BUILDDIR_SRC} |
| 85 | @cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \; |
| 86 | |
| 87 | .PHONY: docs |
| 88 | docs: clean venv ${BUILDDIR_SRC} |
| 89 | @( \ |
| 90 | . ${VENV_DIR}/bin/activate; \ |
| 91 | make -C ${SCRIPTS_DIR} generate && \ |
| 92 | $(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \ |
| 93 | ) |
| 94 | |
| 95 | .PHONY: clean |
| 96 | clean: |
| 97 | @rm -rf $(BUILDDIR) |
| 98 | @make -C ${SCRIPTS_DIR} clean |
| 99 | |
| 100 | .PHONY: build |
| 101 | build: docs |
| 102 | |