mirror of
https://github.com/subsurface/subsurface.git
synced 2024-12-01 06:30:26 +00:00
618e38151a
Automate processing of the documentation to ensure it is processable. Also fix some bugs in the existing input files for the documentation and re-enable linting. Signed-off-by: Michael Keller <github@ike.ch>
56 lines
1.9 KiB
Makefile
56 lines
1.9 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_nl mobile-manual-v3
|
|
|
|
HTMLDOCS = $(patsubst %,$(OUT)%.html,$(DOCNAMES))
|
|
TEXTDOCS = $(patsubst %,$(OUT)%.text,$(DOCNAMES))
|
|
PDFDOCS = $(patsubst %,$(OUT)%.pdf,$(DOCNAMES))
|
|
|
|
ASCIIDOC = asciidoc
|
|
A2X = a2x
|
|
BROWSER = firefox
|
|
THEME = compact_subsurface
|
|
PWD = $(realpath .)
|
|
|
|
all: $(HTMLDOCS) $(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
|
|
$(ASCIIDOC) --version > /dev/null 2>&1 || 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) $@
|
|
|
|
# for the web facing version of the desktop manual, just use the post-processing script
|
|
user-manual.html.wp: user-manual.html
|
|
bash ../scripts/prep-manual.sh $<
|
|
|
|
# for the web facing version of the mobile manual, re-create the HTML with only one level in
|
|
# the table of context and then post process
|
|
mobile-manual-v3.html.wp: mobile-manual-v3.txt
|
|
$(ASCIIDOC) -a toc -a toclevels=1 -a themedir=$(PWD) -a theme=$(THEME) -o $(<:%.txt=%.html.tmp) $< && \
|
|
bash ../scripts/prep-manual.sh $(<:%.txt=%.html.tmp) && \
|
|
mv $(<:%.txt=%.html.tmp.wp) $@
|
|
|
|
# Alternatively::
|
|
$(OUT)$(DOCNAME).xhtml: $(DOCSOURCE)
|
|
$(A2X) --icons -f xhtml $<
|
|
|
|
show: $(HTMLDOC)
|
|
$(BROWSER) $<
|
|
|
|
clean:
|
|
rm -f *~ *.xml docbook-xsl.css $(HTMLDOCS) $(TEXTDOCS) $(PDFDOCS)
|