aboutsummaryrefslogtreecommitdiff
path: root/docs/Makefile
blob: 4c617df6c15bc3844e2cb6d6c2c148764570bed5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# Makefile for paper2remarkable documentation
#
# Author: G.J.J. van den Burg
# Copyright (c) 2020 G.J.J. van den Burg
# License: See LICENSE file
#

SHELL := bash
.SHELLFLAGS := -eu -o pipefail -c
MAKEFLAGS += --no-builtin-rules

VENV_DIR=/tmp/p2r_docs/
OUTPUT_DIR=./output

PACKAGE       = p2r
SPHINXBUILD   = sphinx-build
ALLSPHINXOPTS = -d .build/doctrees .

.PHONY: all

all: man

############
# Man page #
############

.PHONY: man output-dir clean_output

man: $(OUTPUT_DIR)/$(PACKAGE).1
	cp $< ../$(PACKAGE).1
	@echo "Generated man page copied to ../$(PACKAGE).1"

$(OUTPUT_DIR)/$(PACKAGE).1: man.rst | output-dir
	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(OUTPUT_DIR)

man.rst: man.md venv
	source $(VENV_DIR)/bin/activate && m2r man.md

output-dir:
	mkdir -p $(OUTPUT_DIR)
	mkdir -p _static

clean_output:
	rm -f man.rst
	rm -rf $(OUTPUT_DIR)
	rm -rf _static

#######################
# Virtual environment #
#######################

.PHONY: venv clean_venv

venv: $(VENV_DIR)/bin/activate

$(VENV_DIR)/bin/activate:
	test -d $(VENV_DIR) || python -m venv $(VENV_DIR)
	source $(VENV_DIR)/bin/activate && pip install m2r
	touch $(VENV_DIR)/bin/activate

clean_venv:
	rm -rf $(VENV_DIR)

############
# Clean up #
############

.PHONY: venv

clean: clean_venv clean_output
	rm -f ../$(PACKAGE).1