mirror of
https://github.com/subsurface/subsurface.git
synced 2025-01-19 22:35:27 +00:00
70ebc2bee7
Unintentionally two versions of the mobile manual were created. This brings all of Willem's changes into the version for Subsurface-mobile v3, and restores the last version of the v2 mobile manual. This commit was manually created from a pull request that was signed off by Willem, given that he wrote most of the text I am copying that SOB into this commit and will assign authorship to him. To avoid further confusion, we now have a v2 and a v3 manual, explicitly named. The corresponding .html.git files were also updated (reflecting our switch to asciidoctor). Signed-off-by: willemferguson <willemferguson@zoology.up.ac.za> Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
45 lines
1.4 KiB
Makefile
45 lines
1.4 KiB
Makefile
#
|
|
# in order for "normal" developers not to have to install asciidoc (which
|
|
# brings in a couple hundred MB of dependencies) we now include both the
|
|
# user-manual.txt and a copy of the generated .html file in git
|
|
#
|
|
# in order to avoid unnecessary thrash with minor version differences, when
|
|
# submitting patches to the user manual, only submit the changes to the .txt
|
|
# file - the maintainer will recreate the .html.git file
|
|
|
|
DOCNAMES = user-manual user-manual_es user-manual_fr user-manual_ru user-manual_nl mobile-manual mobile-manual-v3
|
|
|
|
HTMLDOCS = $(patsubst %,$(OUT)%.html,$(DOCNAMES))
|
|
TEXTDOCS = $(patsubst %,$(OUT)%.text,$(DOCNAMES))
|
|
PDFDOCS = $(patsubst %,$(OUT)%.pdf,$(DOCNAMES))
|
|
|
|
ASCIIDOC = asciidoctor
|
|
A2X = a2x
|
|
BROWSER = firefox
|
|
THEME = compact_subsurface
|
|
PWD = $(realpath .)
|
|
|
|
all: $(HTMLEDOCS) $(TEXTDOCS) $(PDFDOCS)
|
|
|
|
doc: $(HTMLDOCS)
|
|
|
|
$(OUT)%.text: %.txt
|
|
$(A2X) -f text $<
|
|
|
|
$(OUT)%.pdf: %.txt
|
|
-$(A2X) --dblatex-opts "-P latex.output.revhistory=0" -f pdf $<
|
|
|
|
$(OUT)%.html: %.txt
|
|
@echo "if asciidoc isn't found the html file included in the sources is copied"
|
|
$(ASCIIDOC) -a toc -a toclevels=3 -a themedir=$(PWD) -a theme=$(THEME) -o $@ $< || \
|
|
cp $(<:%.txt=%.html.git) $@
|
|
|
|
# Alternatively::
|
|
$(OUT)$(DOCNAME).xhtml: $(DOCSOURCE)
|
|
$(A2X) --icons -f xhtml $<
|
|
|
|
show: $(HTMLDOC)
|
|
$(BROWSER) $<
|
|
|
|
clean:
|
|
rm -f *~ *.xml docbook-xsl.css $(HTMLDOCS) $(TEXTDOCS) $(PDFDOCS)
|