implement subscription handling and api

[proxmox-backup.git] / docs / Makefile

diff --git a/docs/Makefile b/docs/Makefile
index 6039529a1beb8ef8d31d5bf1158d70864664a059..471930c8a0b96f8205188e2a9500ddd02af965c3 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,17 +1,15 @@
 include ../defines.mk
 
-ifeq ($(BUILD_MODE), release)
-COMPILEDIR := ../target/release
-else
-COMPILEDIR := ../target/debug
-endif
-
-GENERATED_SYNOPSIS :=                          \
-       proxmox-backup-client/synopsis.rst      \
-       proxmox-backup-manager/synopsis.rst     \
-       backup-protocol-api.rst
+GENERATED_SYNOPSIS :=                                          \
+       proxmox-backup-client/synopsis.rst                      \
+       proxmox-backup-client/catalog-shell-synopsis.rst        \
+       proxmox-backup-manager/synopsis.rst                     \
+       pxar/synopsis.rst                                       \
+       backup-protocol-api.rst                                 \
+       reader-protocol-api.rst
 
 MANUAL_PAGES :=                        \
+       pxar.1                          \
        proxmox-backup-proxy.1          \
        proxmox-backup-client.1         \
        proxmox-backup-manager.1
@@ -20,15 +18,18 @@ MANUAL_PAGES :=                     \
 # Sphinx documentation setup
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-PAPER         =
 BUILDDIR      = output
 
+ifeq ($(BUILD_MODE), release)
+COMPILEDIR := ../target/release
+SPHINXOPTS    += -t release
+else
+COMPILEDIR := ../target/debug
+SPHINXOPTS    += -t devbuild
+endif
+
 # Sphinx internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
 
 all: ${MANUAL_PAGES}
 
@@ -36,13 +37,25 @@ all: ${MANUAL_PAGES}
 backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api
        ${COMPILEDIR}/dump-backup-api >$@
 
+# Extract reader protocol docs
+reader-protocol-api.rst: ${COMPILEDIR}/dump-reader-api
+       ${COMPILEDIR}/dump-backup-api >$@
+
 # Build manual pages using rst2man
 
+pxar/synopsis.rst: ${COMPILEDIR}/pxar
+       ${COMPILEDIR}/pxar printdoc > pxar/synopsis.rst
+
+pxar.1: pxar/man1.rst  pxar/description.rst pxar/synopsis.rst
+       rst2man $< >$@
+
 proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
        ${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
 
+proxmox-backup-client/catalog-shell-synopsis.rst: ${COMPILEDIR}/dump-catalog-shell-cli
+       ${COMPILEDIR}/dump-catalog-shell-cli > proxmox-backup-client/catalog-shell-synopsis.rst
 
-proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst
+proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst  proxmox-backup-client/catalog-shell-synopsis.rst
        rst2man $< >$@
 
 proxmox-backup-manager/synopsis.rst: ${COMPILEDIR}/proxmox-backup-manager
@@ -54,18 +67,27 @@ proxmox-backup-manager.1: proxmox-backup-manager/man1.rst  proxmox-backup-manage
 proxmox-backup-proxy.1: proxmox-backup-proxy/man1.rst  proxmox-backup-proxy/description.rst
        rst2man $< >$@
 
+.PHONY: onlinehelpinfo
+onlinehelpinfo:
+       @echo "Generating OnlineHelpInfo.js..."
+       $(SPHINXBUILD) -b proxmox-scanrefs $(ALLSPHINXOPTS) $(BUILDDIR)/scanrefs
+       @echo "Build finished. OnlineHelpInfo.js is in $(BUILDDIR)/scanrefs."
+
 .PHONY: html
-html: ${GENERATED_SYNOPSIS}
+html: ${GENERATED_SYNOPSIS} images/proxmox-logo.svg custom.css conf.py
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+       cp images/proxmox-logo.svg $(BUILDDIR)/html/_static/
+       cp custom.css $(BUILDDIR)/html/_static/
        @echo
        @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 .PHONY: latexpdf
 latexpdf: ${GENERATED_SYNOPSIS}
+       @echo "Requires python3-sphinx, texlive-xetex, xindy and texlive-fonts-extra"
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-       @echo "Running LaTeX files through pdflatex..."
+       @echo "Running LaTeX files through xelatex..."
        $(MAKE) -C $(BUILDDIR)/latex all-pdf
-       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+       @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex."
 
 .PHONY: epub3
 epub3: ${GENERATED_SYNOPSIS}
@@ -74,8 +96,27 @@ epub3: ${GENERATED_SYNOPSIS}
        @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
 
 clean:
-       rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} backup-protocol-api.rst
+       rm -r -f *~ *.1 ${BUILDDIR} ${GENERATED_SYNOPSIS}
 
-install: ${MANUAL_PAGES}
+
+install_manual_pages: ${MANUAL_PAGES}
        install -dm755 $(DESTDIR)$(MAN1DIR)
        for i in ${MANUAL_PAGES}; do install -m755 $$i $(DESTDIR)$(MAN1DIR)/ ; done
+
+install_html: html
+       install -dm755 $(DESTDIR)$(DOCDIR)
+       rsync -a ${BUILDDIR}/html $(DESTDIR)$(DOCDIR)
+
+install_pdf: latexpdf
+       install -dm755 $(DESTDIR)$(DOCDIR)
+       install -m 0644 output/latex/ProxmoxBackup.pdf $(DESTDIR)$(DOCDIR)/proxmox-backup.pdf
+
+ifneq ($(filter nodoc,$(DEB_BUILD_PROFILES)),)
+
+install: install_manual_pages
+
+else
+
+install: install_manual_pages install_html install_pdf
+
+endif