mirror of
https://github.com/Tha14/toxic.git
synced 2024-11-22 20:23:01 +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:
parent
1a8fdb1b99
commit
328587ad9c
@ -24,7 +24,8 @@ Toxic is a [Tox](https://tox.im)-based instant messenging client which formerly
|
|||||||
|
|
||||||
##### Documentation
|
##### Documentation
|
||||||
* [Asciidoc](http://asciidoc.org/index.html) Only required for regenerating manpages.
|
* [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
|
### Compiling
|
||||||
1. `cd build/`
|
1. `cd build/`
|
||||||
|
@ -69,12 +69,6 @@ toxic: $(OBJ)
|
|||||||
|
|
||||||
doc: $(MANFILES:%=$(DOC_DIR)/%)
|
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:
|
clean:
|
||||||
rm -rf *.d *.o toxic
|
rm -rf *.d *.o toxic
|
||||||
rm -rf $(MANFILES)
|
rm -rf $(MANFILES)
|
||||||
|
12
doc/Makefile
Normal file
12
doc/Makefile
Normal 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
|
Loading…
Reference in New Issue
Block a user