diff options
| author | Loïc Hoguin <[email protected]> | 2015-05-07 21:00:53 +0300 |
|---|---|---|
| committer | Loïc Hoguin <[email protected]> | 2015-05-07 21:00:53 +0300 |
| commit | 030041dc06f80371aecc929e43fdf870d1f09973 (patch) | |
| tree | 91a1eb56f954f8598a679d8589a6c7c494fc15a8 /plugins | |
| parent | 49ffed442a9e01e79e3561da1f92f77bad1d38cd (diff) | |
| download | erlang.mk-030041dc06f80371aecc929e43fdf870d1f09973.tar.gz erlang.mk-030041dc06f80371aecc929e43fdf870d1f09973.tar.bz2 erlang.mk-030041dc06f80371aecc929e43fdf870d1f09973.zip | |
Add Asciidoc documentation support
Diffstat (limited to 'plugins')
| -rw-r--r-- | plugins/asciidoc.mk | 46 | ||||
| -rw-r--r-- | plugins/edoc.mk | 14 |
2 files changed, 50 insertions, 10 deletions
diff --git a/plugins/asciidoc.mk b/plugins/asciidoc.mk new file mode 100644 index 0000000..baf4d3b --- /dev/null +++ b/plugins/asciidoc.mk @@ -0,0 +1,46 @@ +# Copyright (c) 2015, Loïc Hoguin <[email protected]> +# This file is part of erlang.mk and subject to the terms of the ISC License. + +.PHONY: asciidoc asciidoc-guide asciidoc-manual install-asciidoc distclean-asciidoc + +MAN_INSTALL_PATH ?= /usr/local/share/man +MAN_SECTIONS ?= 3 7 + +docs:: asciidoc + +asciidoc: distclean-asciidoc doc-deps asciidoc-guide asciidoc-manual + +ifeq ($(wildcard doc/src/guide/book.asciidoc),) +asciidoc-guide: +else +asciidoc-guide: + a2x -v -f pdf doc/src/guide/book.asciidoc && mv doc/src/guide/book.pdf doc/guide.pdf + a2x -v -f chunked doc/src/guide/book.asciidoc && mv doc/src/guide/book.chunked/ doc/html/ +endif + +ifeq ($(wildcard doc/src/manual/*.asciidoc),) +asciidoc-manual: +else +asciidoc-manual: + for f in doc/src/manual/*.asciidoc ; do \ + a2x -v -f manpage $$f ; \ + done + for s in $(MAN_SECTIONS); do \ + mkdir -p doc/man$$s/ ; \ + mv doc/src/manual/*.$$s doc/man$$s/ ; \ + gzip doc/man$$s/*.$$s ; \ + done + +install-docs:: install-asciidoc + +install-asciidoc: asciidoc-manual + for s in $(MAN_SECTIONS); do \ + mkdir -p $(MAN_INSTALL_PATH)/man$$s/ ; \ + install -g 0 -o 0 -m 0644 doc/man$$s/*.gz $(MAN_INSTALL_PATH)/man$$s/ ; \ + done +endif + +distclean:: distclean-asciidoc + +distclean-asciidoc: + $(gen_verbose) rm -rf doc/html/ doc/guide.pdf doc/man3/ doc/man7/ diff --git a/plugins/edoc.mk b/plugins/edoc.mk index d9b1d70..6f0a82d 100644 --- a/plugins/edoc.mk +++ b/plugins/edoc.mk @@ -1,8 +1,7 @@ # Copyright (c) 2013-2015, Loïc Hoguin <[email protected]> -# Copyright (c) 2015, Viktor Söderqvist <[email protected]> # This file is part of erlang.mk and subject to the terms of the ISC License. -.PHONY: distclean-edoc build-doc-deps +.PHONY: distclean-edoc edoc # Configuration. @@ -10,19 +9,14 @@ EDOC_OPTS ?= # Core targets. -docs:: distclean-edoc build-doc-deps - $(gen_verbose) $(ERL) -eval 'edoc:application($(PROJECT), ".", [$(EDOC_OPTS)]), halt().' +docs:: distclean-edoc edoc distclean:: distclean-edoc # Plugin-specific targets. -DOC_DEPS_DIRS = $(addprefix $(DEPS_DIR)/,$(DOC_DEPS)) - -$(foreach dep,$(DOC_DEPS),$(eval $(call dep_target,$(dep)))) - -build-doc-deps: $(DOC_DEPS_DIRS) - @for dep in $(DOC_DEPS_DIRS) ; do $(MAKE) -C $$dep; done +edoc: doc-deps + $(gen_verbose) $(ERL) -eval 'edoc:application($(PROJECT), ".", [$(EDOC_OPTS)]), halt().' distclean-edoc: $(gen_verbose) rm -f doc/*.css doc/*.html doc/*.png doc/edoc-info |