docs/Makefile

   1 # Minimal makefile for Sphinx documentation
   2 #
   3 # We support MacOS for docs generation
   4 ifeq ($(shell uname),Darwin)
   5 OS_ID = darwin
   6 endif
   7
   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
  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')
  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"
  23
  24 # You can set these variables from the command line.
  25 SPHINXOPTS        = --keep-going -n -W
  26 SPHINXBUILD       = sphinx-build
  27 SPHINXPROJ        = fdio-vpp
  28 SOURCEDIR         = .
  29 BUILDDIR          = ${BR}/docs
  30 BUILDDIR_SRC      = ${BUILDDIR}/src
  31 BUILDDIR_OUT      = ${BUILDDIR}/html
  32 SCRIPTS_DIR       = _scripts
  33
  34
  35 # Put it first so that "make" without argument is like "make help".
  36 .PHONY: help
  37 help:
  38         @( \
  39           . ${VENV_DIR}/bin/activate; \
  40           $(SPHINXBUILD) --help ;\
  41         )
  42
  43 .PHONY: checkdeps
  44 checkdeps:
  45         @echo "Checking whether dependencies for Docs are installed..."
  46 ifeq ($(OS_ID),ubuntu)
  47         @set -e; inst=; \
  48                 for i in $(DOC_DEB_DEPENDS); do \
  49                         dpkg-query --show $$i >/dev/null 2>&1 || inst="$$inst $$i"; \
  50                 done; \
  51                 if [ "$$inst" ]; then \
  52                         sudo apt-get update; \
  53                         sudo apt-get $(CONFIRM) $(FORCE) install $$inst; \
  54                 fi
  55 else ifneq ("$(wildcard /etc/redhat-release)","")
  56         @sudo yum install $(CONFIRM) $(DOC_RPM_DEPENDS)
  57 endif
  58
  59 .PHONY: spell
  60 spell: clean checkdeps venv ${BUILDDIR_SRC}
  61         @( \
  62           . ${VENV_DIR}/bin/activate; \
  63           make -C ${SCRIPTS_DIR} generate && \
  64           $(SPHINXBUILD) -b spelling $(SPHINXOPTS) $(BUILDDIR_SRC) $(BUILDDIR_OUT); \
  65         )
  66
  67 .PHONY: venv
  68 venv:
  69         @( \
  70             if [ ! -d ${VENV_DIR} ]; then \
  71               ${PYTHON} -m venv ${VENV_DIR}; \
  72               . ${VENV_DIR}/bin/activate; \
  73               ${PYTHON} -m pip install pip==${PIP_VERSION}; \
  74               ${PYTHON} -m pip install pip-tools==${PIP_TOOLS_VERSION}; \
  75               ${PYTHON} -m pip install -r ${WS_ROOT}/test/requirements-3.txt; \
  76             fi; \
  77         )
  78
  79 ${BUILDDIR_SRC}:
  80         @mkdir -p ${BUILDDIR_SRC}
  81         @cp -r $(SOURCEDIR) ${BUILDDIR_SRC}
  82         @cd ${BUILDDIR_SRC} && find . -type l -exec cp --remove-destination -L ${DOCS_DIR}/{} {} \;
  83
  84 .PHONY: docs
  85 docs: clean venv ${BUILDDIR_SRC}
  86         @( \
  87           . ${VENV_DIR}/bin/activate; \
  88           make -C ${SCRIPTS_DIR} generate && \
  89           $(SPHINXBUILD) $(SPHINXOPTS) -b html $(BUILDDIR_SRC) $(BUILDDIR_OUT); \
  90         )
  91
  92 .PHONY: clean
  93 clean:
  94         @rm -rf $(BUILDDIR) ${VENV_DIR}
  95         @make -C ${SCRIPTS_DIR} clean
  96
  97 .PHONY: build
  98 build: docs
  99