summaryrefslogtreecommitdiff
path: root/Makefile
blob: a5a5090249b1a509ec85955e4e7bdc8422b54846 (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
72
73
74
75
76
77
78
79
80
81
all:

install:

clean:

BRANCH = 1.10

HOTDOC ?= hotdoc
prefix ?= /usr
datadir ?= ${prefix}/share
devhelpdir ?= ${datadir}/devhelp/books
docdir ?= ${datadir}/doc/${PACKAGE}
htmldir ?= ${docdir}

# emulate Automake well enough for hotdoc.mk
AM_V_GEN ?=
AMTAR ?= tar
mkinstalldirs ?= install -d
srcdir = $(CURDIR)
top_srcdir = $(CURDIR)
builddir = $(CURDIR)
top_builddir = $(CURDIR)

HOTDOC_PROJECTS = gst-docs

gst_docs_HOTDOC_FLAGS = \
	--conf-file hotdoc.json \
	$(NULL)

theme/theme.stamp: theme/less/variables.less
	+make -C theme/hotdoc_bootstrap_theme LESS_INCLUDE_PATH=$$PWD/theme/less
	@rm -rf hotdoc-private*
	@touch theme/theme.stamp

clean_theme:
	rm -f theme/theme.stamp
	+make -C theme/hotdoc_bootstrap_theme clean

clean: clean_theme

gst_docs_HOTDOC_EXTRA_DEPS = theme/theme.stamp

.PHONY: all install clean

-include $(shell $(HOTDOC) --makefile-path)

# These variables define the location of the online docs
#
# If your local username and your fdo username differ, you
# will need to add an entry for gstreamer.freedesktop.org
# in your ~/.ssh/config with the right username for the server.
#
# DOC_SERVER = people.freedesktop.org
# DOC_BASE = public_html/gst-docs
DOC_SERVER = gstreamer.freedesktop.org
DOC_BASE = /srv/gstreamer.freedesktop.org/public_html/documentation

# The local build directory with the generated HTML output
BUILT_DOC_DIR = $(builddir)/built_doc/html/

check-for-hotdoc:
	@$(HOTDOC) --version >/dev/null 2>/dev/null

upload: check-for-hotdoc all
	rsync -rvaz -e ssh --links --delete $(BUILT_DOC_DIR) $(DOC_SERVER):$(DOC_BASE) || /bin/true
	ssh $(DOC_SERVER) "chmod -R g+w $(DOC_BASE); chgrp -R gstreamer $(DOC_BASE)"

include plugins-introspection/plugins-introspection.mak

help:
	@echo
	@echo "  make                     -- Build or rebuild docs (markdown -> html)"
	@echo
	@echo "  make upload              -- Upload docs"
	@echo
	@echo "  make update-xml          -- Update local plugin module .xml files from git"
	@echo "  make update-plugin-list  -- Rebuild local plugins.md list from .xml files"
	@echo
	@echo "  make clean-url-cache     -- Remove local url cache"
	@echo