src/client/http_client.rs: allow upload with parameters

[proxmox-backup.git] / docs / Makefile

diff --git a/docs/Makefile b/docs/Makefile
index a60973c94c16754b99ae2c6c003b0e489a25b5ce..327cedad13561bec1771300c7927f2ada1581a3d 100644 (file)
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -6,18 +6,68 @@ else
 COMPILEDIR := ../target/debug
 endif
 
-##UNITS:= proxmox-backup-client
+GENERATED_SYNOPSIS :=                          \
+       proxmox-backup-client/synopsis.rst      \
+       backup-protocol-api.rst
 
-proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst ${COMPILEDIR}/proxmox-backup-client
+MANUAL_PAGES :=                        \
+       proxmox-backup-proxy.1          \
+       proxmox-backup-client.1
+
+
+# Sphinx documentation setup
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = output
+
+# 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) .
+
+all: ${MANUAL_PAGES}
+
+# Extract backup protocol docs
+backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api
+       ${COMPILEDIR}/dump-backup-api >$@
+
+# Build manual pages using rst2man
+
+proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
        ${COMPILEDIR}/proxmox-backup-client printdoc > proxmox-backup-client/synopsis.rst
+
+
+proxmox-backup-client.1: proxmox-backup-client/man1.rst  proxmox-backup-client/description.rst proxmox-backup-client/synopsis.rst
        rst2man $< >$@
 
-all: proxmox-backup-client.1
+proxmox-backup-proxy.1: proxmox-backup-proxy/man1.rst  proxmox-backup-proxy/description.rst
+       rst2man $< >$@
+
+.PHONY: html
+html: ${GENERATED_SYNOPSIS}
+       $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+       @echo
+       @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+.PHONY: latexpdf
+latexpdf: ${GENERATED_SYNOPSIS}
+       $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+       @echo "Running LaTeX files through pdflatex..."
+       $(MAKE) -C $(BUILDDIR)/latex all-pdf
+       @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
 
+.PHONY: epub3
+epub3: ${GENERATED_SYNOPSIS}
+       $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
+       @echo
+       @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
 
 clean:
-       rm -f *.1 */synopsis.rst
+       rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} backup-protocol-api.rst
 
-install: proxmox-backup-client.1
+install: ${MANUAL_PAGES}
        install -dm755 $(DESTDIR)$(MAN1DIR)
-       install -m755  proxmox-backup-client.1 $(DESTDIR)$(MAN1DIR)/
+       for i in ${MANUAL_PAGES}; do install -m755 $$i $(DESTDIR)$(MAN1DIR)/ ; done