From 8aa49bdfa5298c913caf0e7025f5cc1199fa5612 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Thu, 12 Nov 2020 00:05:14 +0000 Subject: Add man page to package --- docs/Makefile | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 docs/Makefile (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..4c617df --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,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 -- cgit v1.2.3 From fadbad68166a8d3577e5cb3dfe8dba724dacb76d Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Fri, 13 Nov 2020 18:49:32 +0000 Subject: minor fixes to docs --- docs/Makefile | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/Makefile') diff --git a/docs/Makefile b/docs/Makefile index 4c617df..ae82c87 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -44,6 +44,7 @@ clean_output: rm -f man.rst rm -rf $(OUTPUT_DIR) rm -rf _static + rm -rf .build ####################### # Virtual environment # -- cgit v1.2.3