3 GENERATED_SYNOPSIS
:= \
4 proxmox-backup-client
/synopsis.rst \
5 proxmox-backup-client
/catalog-shell-synopsis.rst \
6 proxmox-backup-manager
/synopsis.rst \
8 backup-protocol-api.rst \
9 reader-protocol-api.rst
13 proxmox-backup-proxy
.1 \
14 proxmox-backup-client
.1 \
15 proxmox-backup-manager
.1
18 # Sphinx documentation setup
20 SPHINXBUILD
= sphinx-build
23 ifeq ($(BUILD_MODE
), release
)
24 COMPILEDIR
:= ..
/target
/release
25 SPHINXOPTS
+= -t release
27 COMPILEDIR
:= ..
/target
/debug
28 SPHINXOPTS
+= -t devbuild
32 # Sphinx internal variables.
33 ALLSPHINXOPTS
= -d
$(BUILDDIR
)/doctrees
$(SPHINXOPTS
) .
37 # Extract backup protocol docs
38 backup-protocol-api.rst
: ${COMPILEDIR}/dump-backup-api
39 ${COMPILEDIR}/dump-backup-api
>$@
41 # Extract reader protocol docs
42 reader-protocol-api.rst
: ${COMPILEDIR}/dump-reader-api
43 ${COMPILEDIR}/dump-backup-api
>$@
45 # Build manual pages using rst2man
47 pxar
/synopsis.rst
: ${COMPILEDIR}/pxar
48 ${COMPILEDIR}/pxar printdoc
> pxar
/synopsis.rst
50 pxar
.1: pxar
/man1.rst pxar
/description.rst pxar
/synopsis.rst
53 proxmox-backup-client
/synopsis.rst
: ${COMPILEDIR}/proxmox-backup-client
54 ${COMPILEDIR}/proxmox-backup-client printdoc
> proxmox-backup-client
/synopsis.rst
56 proxmox-backup-client
/catalog-shell-synopsis.rst
: ${COMPILEDIR}/dump-catalog-shell-cli
57 ${COMPILEDIR}/dump-catalog-shell-cli
> proxmox-backup-client
/catalog-shell-synopsis.rst
59 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
62 proxmox-backup-manager
/synopsis.rst
: ${COMPILEDIR}/proxmox-backup-manager
63 ${COMPILEDIR}/proxmox-backup-manager printdoc
> proxmox-backup-manager
/synopsis.rst
65 proxmox-backup-manager
.1: proxmox-backup-manager
/man1.rst proxmox-backup-manager
/description.rst proxmox-backup-manager
/synopsis.rst
68 proxmox-backup-proxy
.1: proxmox-backup-proxy
/man1.rst proxmox-backup-proxy
/description.rst
72 html
: ${GENERATED_SYNOPSIS}
73 $(SPHINXBUILD
) -b html
$(ALLSPHINXOPTS
) $(BUILDDIR
)/html
75 @echo
"Build finished. The HTML pages are in $(BUILDDIR)/html."
78 latexpdf
: ${GENERATED_SYNOPSIS}
79 @echo
"Requires python3-sphinx, texlive-xetex, xindy and texlive-fonts-extra"
80 $(SPHINXBUILD
) -b latex
$(ALLSPHINXOPTS
) $(BUILDDIR
)/latex
81 @echo
"Running LaTeX files through xelatex..."
82 $(MAKE
) -C
$(BUILDDIR
)/latex all-pdf
83 @echo
"xelatex finished; the PDF files are in $(BUILDDIR)/latex."
86 epub3
: ${GENERATED_SYNOPSIS}
87 $(SPHINXBUILD
) -b epub3
$(ALLSPHINXOPTS
) $(BUILDDIR
)/epub3
89 @echo
"Build finished. The epub3 file is in $(BUILDDIR)/epub3."
92 rm -r
-f
*~
*.1 ${BUILDDIR} ${GENERATED_SYNOPSIS}
95 install_manual_pages
: ${MANUAL_PAGES}
96 install -dm755
$(DESTDIR
)$(MAN1DIR
)
97 for i in
${MANUAL_PAGES}; do
install -m755
$$i $(DESTDIR
)$(MAN1DIR
)/ ; done
100 install -dm755
$(DESTDIR
)$(DOCDIR
)
101 rsync
-a
${BUILDDIR}/html
$(DESTDIR
)$(DOCDIR
)
103 install_pdf
: latexpdf
104 install -dm755
$(DESTDIR
)$(DOCDIR
)
105 install -m
0644 output
/latex
/ProxmoxBackup.pdf
$(DESTDIR
)$(DOCDIR
)/proxmox-backup.pdf
107 ifneq ($(filter nodoc
,$(DEB_BUILD_PROFILES
)),)
109 install: install_manual_pages
113 install: install_manual_pages install_html install_pdf