X-Git-Url: https://git.proxmox.com/?p=pve-docs.git;a=blobdiff_plain;f=Makefile;h=4b3e594cb3ba2ef95dfa86ad4b77811af45118d5;hp=5d6784400376b811ae3e6914175ef22b9a4e84a0;hb=effd6c43413600787db1997160cd9926ed431b0a;hpb=e82ab12b04fab7fb944f0aa742ee20d92c0ef9ca diff --git a/Makefile b/Makefile index 5d67844..4b3e594 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ DOC_PACKAGE=pve-docs MEDIAWIKI_PACKAGE=pve-docs-mediawiki # also update debian/changelog -PKGREL=10 +PKGREL=3 GITVERSION:=$(shell cat .git/refs/heads/master) @@ -16,9 +16,15 @@ GEN_DEB=${GEN_PACKAGE}_${DOCRELEASE}-${PKGREL}_${ARCH}.deb DOC_DEB=${DOC_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb MEDIAWIKI_DEB=${MEDIAWIKI_PACKAGE}_${DOCRELEASE}-${PKGREL}_all.deb + all: index.html -.pve-doc-depends link-refs.json: $(wildcard *.adoc) scan-adoc-refs +.PHONY: verify-images +verify-images: + for i in ./images/screenshot/*.png; do ./png-verify.pl $$i; done + +ADOC_SOURCES_GUESS=$(filter-out %-synopsis.adoc %-opts.adoc %-table.adoc, $(wildcard *.adoc)) +.pve-doc-depends link-refs.json: ${ADOC_SOURCES_GUESS} scan-adoc-refs ./scan-adoc-refs *.adoc --depends .pve-doc-depends.tmp > link-refs.json.tmp @cmp --quiet .pve-doc-depends .pve-doc-depends.tmp || mv .pve-doc-depends.tmp .pve-doc-depends @cmp --quiet link-refs.json link-refs.json.tmp || mv link-refs.json.tmp link-refs.json @@ -36,6 +42,8 @@ GEN_DEB_SOURCES= \ docinfo.xml GEN_SCRIPTS= \ + gen-ha-groups-opts.pl \ + gen-ha-resources-opts.pl \ gen-datacenter.cfg.5-opts.pl \ gen-pct.conf.5-opts.pl \ gen-pct-network-opts.pl \ @@ -66,9 +74,13 @@ pve-docs-mediawiki-import: pve-docs-mediawiki-import.in link-refs.json INDEX_INCLUDES= \ pve-admin-guide.pdf \ pve-admin-guide.epub \ + chapter-index-table.adoc \ + man1-index-table.adoc \ + man5-index-table.adoc \ + man8-index-table.adoc \ $(sort $(addsuffix .html, ${MANUAL_PAGES}) ${CHAPTER_LIST}) -ADOC_STDARG= -b html5 -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" +ADOC_STDARG=-b $(shell pwd)/asciidoc/pve-html -f asciidoc/asciidoc-pve.conf -a icons -a data-uri -a "date=$(shell date)" -a "revnumber=${DOCRELEASE}" BROWSER?=xdg-open @@ -77,31 +89,52 @@ BROWSER?=xdg-open nwdiag -T svg $*.nwdiag -o $@; README.html: README.adoc - asciidoc ${ADOC_STDARG} -o $@ $< + asciidoc -a toc ${ADOC_STDARG} -o $@ $< .PHONY: index index: index.html $(BROWSER) index.html & -index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} +chapter-index-table.adoc: asciidoc-pve + ./asciidoc-pve chapter-table >$@.tmp + mv $@.tmp $@ + +man1-index-table.adoc: asciidoc-pve + ./asciidoc-pve man1page-table >$@.tmp + mv $@.tmp $@ + +man5-index-table.adoc: asciidoc-pve + ./asciidoc-pve man5page-table >$@.tmp + mv $@.tmp $@ + +man8-index-table.adoc: asciidoc-pve + ./asciidoc-pve man8page-table >$@.tmp + mv $@.tmp $@ + +index.html: index.adoc ${API_VIEWER_SOURCES} ${INDEX_INCLUDES} asciidoc ${ADOC_STDARG} -o $@ index.adoc pve-admin-guide.html: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} - asciidoc -a pvelogo ${ADOC_STDARG} pve-admin-guide.adoc + asciidoc -a pvelogo ${ADOC_STDARG} -o $@ pve-admin-guide.adoc pve-admin-guide.chunked: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} rm -rf pve-admin-guide.chunked a2x -a docinfo -a docinfo1 -a icons -f chunked pve-admin-guide.adoc +PVE_DOCBOOK_CONF=-b $(shell pwd)/asciidoc/pve-docbook -f asciidoc/asciidoc-pve.conf + +pve-admin-guide-docinfo.xml: pve-admin-guide-docinfo.xml.in + sed -e 's/@RELEASE@/${DOCRELEASE}/' <$< >$@ + pve-admin-guide.pdf: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} docinfo.xml pve-admin-guide-docinfo.xml inkscape -z -D --export-pdf=proxmox-logo.pdf images/proxmox-logo.svg inkscape -z -D --export-pdf=proxmox-ci-header.pdf images/proxmox-ci-header.svg 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" --dblatex-opts "-P doc.publisher.show=0 -s asciidoc/dblatex-custom.sty" pve-admin-guide.adoc + a2x -a docinfo -a docinfo1 -f pdf -L --asciidoc-opts="${PVE_DOCBOOK_CONF}" --dblatex-opts "-p ./asciidoc/pve-dblatex.xsl -s asciidoc/dblatex-custom.sty" pve-admin-guide.adoc rm proxmox-logo.pdf proxmox-ci-header.pdf pve-admin-guide.epub: ${PVE_ADMIN_GUIDE_ADOCDEPENDS} - a2x -f epub pve-admin-guide.adoc + a2x -f epub --asciidoc-opts="${PVE_DOCBOOK_CONF}" pve-admin-guide.adoc api-viewer/apidata.js: extractapi.pl ./extractapi.pl >$@ @@ -118,7 +151,7 @@ deb: rm -f ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; make ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}; -${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import asciidoc/mediawiki.conf +${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPORTS} ${API_VIEWER_SOURCES} ${GEN_DEB_SOURCES} asciidoc-pve pve-docs-mediawiki-import asciidoc/mediawiki.conf verify-images rm -rf build mkdir build rsync -a debian/ build/debian @@ -130,13 +163,19 @@ ${GEN_DEB} ${DOC_DEB} ${MEDIAWIKI_DEB}: index.html ${INDEX_INCLUDES} ${WIKI_IMPO mkdir -p build/usr/bin install -m 0644 ${GEN_DEB_SOURCES} build/usr/share/${GEN_PACKAGE} install -m 0755 ${GEN_SCRIPTS} build/usr/share/${GEN_PACKAGE} + # install asciidoc-pve install -m 0755 asciidoc-pve build/usr/bin/ - install -D -m 0644 asciidoc/mediawiki.conf build/etc/asciidoc/mediawiki.conf + install -D -m 0644 asciidoc/mediawiki.conf build/usr/share/${GEN_PACKAGE}/asciidoc/mediawiki.conf + install -m 0644 asciidoc/asciidoc-pve.conf build/usr/share/${GEN_PACKAGE}/asciidoc/ + install -m 0644 asciidoc/pve-html.conf build/usr/share/${GEN_PACKAGE}/asciidoc/ # install files for pvedocs package mkdir -p build/usr/share/${DOC_PACKAGE} mkdir -p build/usr/share/doc/${DOC_PACKAGE} install -m 0644 index.html ${INDEX_INCLUDES} build/usr/share/${DOC_PACKAGE} install -m 0644 ${WIKI_IMPORTS} build/usr/share/${DOC_PACKAGE} + # install screenshot images + mkdir -p build/usr/share/${DOC_PACKAGE}/images/screenshot + install -m 0644 images/screenshot/*.png build/usr/share/${DOC_PACKAGE}/images/screenshot # install api doc viewer mkdir build/usr/share/${DOC_PACKAGE}/api-viewer install -m 0644 ${API_VIEWER_SOURCES} build/usr/share/${DOC_PACKAGE}/api-viewer @@ -158,5 +197,4 @@ update: clean make all clean: - rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import .pve-doc-depends pve-doc-generator.mk - find . -name '*~' -exec rm {} ';' + rm -rf *.html *.pdf *.epub *.tmp *.1 *.5 *.8 *.deb *.changes build api-viewer/apidoc.js chapter-*.html *-plain.html chapter-*.html pve-admin-guide.chunked asciidoc-pve link-refs.json .asciidoc-pve-tmp_* pve-docs-mediawiki-import .pve-doc-depends pve-doc-generator.mk chapter-index-table.adoc man1-index-table.adoc man5-index-table.adoc man8-index-table.adoc pve-admin-guide-docinfo.xml