1
0
mirror of https://github.com/Tha14/toxic.git synced 2024-12-22 22:33:25 +01:00

doc: Make asciidoc extra optional.

Completely separate man page generation from the main build to satisfy
travis-ci behaviour.

Signed-off-by: Loui Chang <louipc.ist@gmail.com>
This commit is contained in:
Loui Chang 2014-08-24 17:00:25 -04:00
parent 1a8fdb1b99
commit 328587ad9c
3 changed files with 14 additions and 7 deletions

View File

@ -24,7 +24,8 @@ Toxic is a [Tox](https://tox.im)-based instant messenging client which formerly
##### Documentation
* [Asciidoc](http://asciidoc.org/index.html) Only required for regenerating manpages.
* Run `make doc` in the build directory after editing the asciidoc to regenerate the manpages.
* Run `make` in the doc directory after editing the asciidoc to regenerate the manpages.
* Asciidoc files and generated manpages will need to be commited together.
### Compiling
1. `cd build/`

View File

@ -69,12 +69,6 @@ toxic: $(OBJ)
doc: $(MANFILES:%=$(DOC_DIR)/%)
$(DOC_DIR)/%: $(DOC_DIR)/%.asc
@echo " Generating man page $(@F)"
@a2x -f manpage -a revdate=$(shell git log -1 --date=short --format="%ad" $<) \
-a manmanual="toxic manual" -a mansource=toxic \
-a manversion=__VERSION__ -a datadir=__DATADIR__ $<
clean:
rm -rf *.d *.o toxic
rm -rf $(MANFILES)

12
doc/Makefile Normal file
View File

@ -0,0 +1,12 @@
MANFILES = toxic.1 toxic.conf.5
# Targets
doc: $(MANFILES)
%: %.asc
@echo " Generating man page $(@F)"
@a2x -f manpage -a revdate=$(shell git log -1 --date=short --format="%ad" $<) \
-a manmanual="toxic manual" -a mansource=toxic \
-a manversion=__VERSION__ -a datadir=__DATADIR__ $<
.PHONY: doc