Makefile

SHELL = bash

include util.mk


# ==========================================
#                 environment
# ==========================================
#
# Miscellaneous tools:
# Software tests, Documentation builder, Virtual environment builder

# Build documentation.
docs-html: virtualenv
	@# TODO: Invoke from `conf.py`.
	$(MAKE) rst2md
	export SPHINXBUILD="$(PWD)/$(sphinx)"; cd doc; make html

# Continuously build documentation.
docs-autobuild: virtualenv
	$(pip) --quiet install sphinx-autobuild
	$(sphinx-autobuild) --open-browser doc/source doc/build

# Run link checker on documentation.
docs-linkcheck: virtualenv
	$(sphinx) -j auto -n -W --keep-going -b linkcheck doc/source doc/build

virtualenv: setup-virtualenv
	@echo Installing packages from requirements-docs.txt.
	$(pip) install --quiet --upgrade --requirement requirements-docs.txt

rst2md:
	cat doc/source/resources.rst | $(python) doc/rst2md.py > doc/source/resources-md.md


# ==========================================
#            ptrace.hiveeyes.org
# ==========================================

# Don't commit media assets (screenshots, etc.) to the repository.
# Instead, upload them to https://ptrace.hiveeyes.org/
ptrace_target := root@ptrace.hiveeyes.org:/var/www/ptrace.hiveeyes.org/htdocs/
ptrace_http   := https://ptrace.hiveeyes.org/
ptrace: check-ptrace-options
	$(eval prefix         := $(shell date --iso-8601))
	$(eval name           := $(shell basename '$(source)'))
	$(eval file_name      := $(prefix)_$(name))
	$(eval file_escaped   := $(shell printf %q "$(file_name)"))
	$(eval file_url       := $(shell echo -n "$(file_name)" | python -c "import sys, urllib; print urllib.quote(sys.stdin.read())"))

	$(eval upload_command := scp '$(source)' '$(ptrace_target)$(file_escaped)')
	$(eval media_url      := $(ptrace_http)$(file_url))

	@# debugging
	@#echo "name:         $(name)"
	@#echo "file_name:    $(file_name)"
	@#echo "file_escaped: $(file_escaped)"
	@#echo "command:      $(upload_command)"

	$(upload_command)

	@echo "Access URL: $(media_url)"

check-ptrace-options:
	@if test "$(source)" = ""; then \
		echo "ERROR: 'source' not set"; \
		exit 1; \
	fi