add TOC to individual chapter files

[pve-docs.git] / Makefile

diff --git a/Makefile b/Makefile
index 52b7e0fb42f44996ad173df6e081b3fad22da958..86c8bc9e2cddfd2d4233fe31bb555e82d0607d63 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -15,6 +15,21 @@ GITVERSION:=$(shell cat .git/refs/heads/master)
 GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${GEN_PKGREL}_amd64.deb
 DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${DOC_PKGREL}_all.deb
 
+CHAPTER_LIST=          \
+       sysadmin        \
+       pvecm           \
+       pmxcfs          \
+       pvesm           \
+       qm              \
+       pve-firewall    \
+       pveum           \
+       pct             \
+       ha-manager      \
+       vzdump          \
+       pve-faq         \
+       pve-bibliography
+
+
 COMMAND_LIST=          \
        pvesubscription \
        pvecm           \
@@ -124,11 +139,15 @@ ADOC_MAN8_HTML_ARGS=-a "manvolnum=8" ${ADOC_STDARG} -a "revnumber=${DOCRELEASE}"
 
 BROWSER?=xdg-open
 
-all: pve-admin-guide.html
+all: index.html
 
 %-nwdiag.svg: %.nwdiag
        nwdiag -T svg $*.nwdiag -o $@;
 
+chapter-%.html: %.adoc ${PVE_COMMON_DOC_SOURCES}
+       asciidoc ${ADOC_STDARG} -a toc -o $@ $*.adoc
+       test -n "$${NOVIEW}" || $(BROWSER) $@ &
+
 %.1.html: %.adoc %.1-synopsis.adoc ${PVE_COMMON_DOC_SOURCES}
        asciidoc ${ADOC_MAN1_HTML_ARGS} -o $@ $*.adoc
        test -n "$${NOVIEW}" || $(BROWSER) $@ &
@@ -146,16 +165,25 @@ pmxcfs.8.html: pmxcfs.adoc pmxcfs.8-cli.adoc ${PVE_COMMON_DOC_SOURCES}
        asciidoc ${ADOC_MAN5_HTML_ARGS} -o $@ $*.adoc
        test -n "$${NOVIEW}" || $(BROWSER) $@ &
 
+.PHONY: index
+index: index.html
+       test -n "$${NOVIEW}" || $(BROWSER) index.html &
+
 index.html: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
        $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
        $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
+       $(MAKE) NOVIEW=1 $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))
        asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
-       test -n "$${NOVIEW}" || $(BROWSER) index.html &
 
 pve-admin-guide.html: ${PVE_ADMIN_GUIDE_SOURCES}
        asciidoc -a "revnumber=${DOCRELEASE}" -a "date=$(shell date)" pve-admin-guide.adoc
        test -n "$${NOVIEW}" || $(BROWSER) $@ &
 
+pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_SOURCES}
+       rm -rf pve-admin-guide.chunked
+       a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc
+       test -n "$${NOVIEW}" || $(BROWSER) $@/index.html &
+
 pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_SOURCES} docinfo.xml pve-admin-guide-docinfo.xml
        grep ">Release ${DOCRELEASE}<" pve-admin-guide-docinfo.xml || (echo "wrong release in  pve-admin-guide-docinfo.xml" && false);
        a2x -a docinfo -a docinfo1 -f pdf -L --dblatex-opts "-P latex.output.revhistory=0" --dblatex-opts "-P latex.class.options=12pt" --dblatex-opts "-P doc.section.depth=2 -P toc.section.depth=2" pve-admin-guide.adoc
@@ -182,19 +210,17 @@ deb:
        make ${GEN_DEB};
        make ${DOC_DEB};
 
-DOC_DEB_FILES=                                 \
-       $(addsuffix .1.html, ${COMMAND_LIST})   \
-       $(addsuffix .8.html, ${SERVICE_LIST})   \
-       $(addsuffix .5.html, ${CONFIG_LIST})    \
+DOC_DEB_FILES=                                                         \
+       $(addsuffix .html, $(addprefix chapter-, ${CHAPTER_LIST}))      \
+       $(addsuffix .1.html, ${COMMAND_LIST})                           \
+       $(addsuffix .8.html, ${SERVICE_LIST})                           \
+       $(addsuffix .5.html, ${CONFIG_LIST})                            \
        pve-admin-guide.pdf     \
        pve-admin-guide.html    \
        pve-admin-guide.epub    \
        index.html
 
-${DOC_DEB}: index.adoc ${PVE_ADMIN_GUIDE_SOURCES} ${API_VIEWER_SOURCES}
-       $(MAKE) NOVIEW=1 pve-admin-guide.pdf pve-admin-guide.html pve-admin-guide.epub
-       $(MAKE) NOVIEW=1 $(addsuffix .1.html, ${COMMAND_LIST}) $(addsuffix .8.html, ${SERVICE_LIST}) $(addsuffix .5.html, ${CONFIG_LIST})
-       asciidoc -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" index.adoc
+${DOC_DEB}: index.html
        rm -rf build
        mkdir build
        rsync -a doc-debian/ build/debian
@@ -232,10 +258,13 @@ upload: ${GEN_DEB} ${DOC_DEB}
        cd /pve/${DOCRELEASE}/extra; dpkg-scanpackages . /dev/null > Packages; gzip -9c Packages > Packages.gz
        umount /pve/${DOCRELEASE}; mount /pve/${DOCRELEASE} -o ro
 
+.PHONY: update
 update: clean
-       rm -f *.5-opts.adoc .1-synopsis.adoc .8-synopsis.adoc
+       rm -f *.5-opts.adoc *.1-synopsis.adoc *.8-synopsis.adoc
+       rm -f api-viewer/apidata.js
+       rm -f pve-firewall-macros.adoc
        make all
 
 clean:
-       rm -rf *~ *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidata.js api-viewer/apidoc.js
-
+       rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html pve-admin-guide.chunked
+       find . -name '*~' -exec rm {} ';'