docs/Makefile

   1 include ../defines.mk
   2
   3 GENERATED_SYNOPSIS :=                                           \
   4         proxmox-tape/synopsis.rst                               \
   5         proxmox-backup-client/synopsis.rst                      \
   6         proxmox-backup-client/catalog-shell-synopsis.rst        \
   7         proxmox-backup-manager/synopsis.rst                     \
   8         proxmox-backup-debug/synopsis.rst                       \
   9         proxmox-file-restore/synopsis.rst                       \
  10         pxar/synopsis.rst                                       \
  11         pmtx/synopsis.rst                                       \
  12         pmt/synopsis.rst                                        \
  13         config/media-pool/config.rst                            \
  14         config/tape/config.rst                                  \
  15         config/tape-job/config.rst                              \
  16         config/user/config.rst                                  \
  17         config/remote/config.rst                                \
  18         config/sync/config.rst                                  \
  19         config/verification/config.rst                          \
  20         config/acl/roles.rst                                    \
  21         config/datastore/config.rst                             \
  22         config/domains/config.rst
  23
  24 MAN1_PAGES :=                           \
  25         pxar.1                          \
  26         pmtx.1                          \
  27         pmt.1                           \
  28         proxmox-tape.1                  \
  29         proxmox-backup-proxy.1          \
  30         proxmox-backup-client.1         \
  31         proxmox-backup-manager.1        \
  32         proxmox-file-restore.1          \
  33         proxmox-backup-debug.1
  34
  35 MAN5_PAGES :=                           \
  36         media-pool.cfg.5                \
  37         tape.cfg.5                      \
  38         tape-job.cfg.5                  \
  39         acl.cfg.5                       \
  40         user.cfg.5                      \
  41         remote.cfg.5                    \
  42         sync.cfg.5                      \
  43         verification.cfg.5              \
  44         datastore.cfg.5                 \
  45         domains.cfg.5
  46
  47 PRUNE_SIMULATOR_FILES :=                                        \
  48         prune-simulator/index.html                              \
  49         prune-simulator/documentation.html                      \
  50         prune-simulator/clear-trigger.png                       \
  51         prune-simulator/prune-simulator.js
  52
  53 PRUNE_SIMULATOR_JS_SOURCE :=                                            \
  54         /usr/share/javascript/proxmox-widget-toolkit-dev/Toolkit.js     \
  55         prune-simulator/prune-simulator_source.js
  56
  57 LTO_BARCODE_JS_SOURCE :=                                                \
  58         /usr/share/javascript/proxmox-widget-toolkit-dev/Toolkit.js     \
  59         lto-barcode/code39.js                                           \
  60         lto-barcode/prefix-field.js                                     \
  61         lto-barcode/label-style.js                                      \
  62         lto-barcode/tape-type.js                                        \
  63         lto-barcode/paper-size.js                                       \
  64         lto-barcode/page-layout.js                                      \
  65         lto-barcode/page-calibration.js                                 \
  66         lto-barcode/label-list.js                                       \
  67         lto-barcode/label-setup.js                                      \
  68         lto-barcode/lto-barcode.js
  69
  70 LTO_BARCODE_FILES :=                                            \
  71         lto-barcode/index.html                                  \
  72         lto-barcode/lto-barcode-generator.js
  73
  74 API_VIEWER_SOURCES=                             \
  75         api-viewer/index.html                   \
  76         api-viewer/apidoc.js
  77
  78 API_VIEWER_FILES :=                                                     \
  79         api-viewer/apidata.js                                           \
  80         /usr/share/javascript/proxmox-widget-toolkit-dev/APIViewer.js   \
  81
  82 # Sphinx documentation setup
  83 SPHINXOPTS    =
  84 SPHINXBUILD   = sphinx-build
  85 BUILDDIR      = output
  86
  87 ifeq ($(BUILD_MODE), release)
  88 COMPILEDIR := ../target/release
  89 SPHINXOPTS    += -t release
  90 else
  91 COMPILEDIR := ../target/debug
  92 SPHINXOPTS    += -t devbuild
  93 endif
  94
  95 # Sphinx internal variables.
  96 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
  97
  98 all: ${MAN1_PAGES} ${MAN5_PAGES}
  99
 100 config/%/config.rst: ${COMPILEDIR}/docgen
 101         ${COMPILEDIR}/docgen $*.cfg >$@
 102
 103 config/acl/roles.rst: ${COMPILEDIR}/docgen
 104         ${COMPILEDIR}/docgen "config::acl::Role" >$@
 105
 106 %/synopsis.rst: ${COMPILEDIR}/%
 107         $< printdoc > $@
 108
 109 proxmox-backup-client/catalog-shell-synopsis.rst: ${COMPILEDIR}/dump-catalog-shell-cli
 110         ${COMPILEDIR}/dump-catalog-shell-cli > proxmox-backup-client/catalog-shell-synopsis.rst
 111
 112 ${MAN1_PAGES} ${MAN5_PAGES}: man-pages
 113
 114 .PHONY: man-pages
 115 man-pages: ${GENERATED_SYNOPSIS}
 116         ${SPHINXBUILD} ${SPHINXOPTS} -b man ./ ${BUILDDIR}/man
 117
 118 .PHONY: onlinehelpinfo
 119 onlinehelpinfo:
 120         @echo "Generating OnlineHelpInfo.js..."
 121         $(SPHINXBUILD) -b proxmox-scanrefs -Q $(ALLSPHINXOPTS) $(BUILDDIR)/scanrefs
 122         @echo "Build finished. OnlineHelpInfo.js is in $(BUILDDIR)/scanrefs."
 123
 124 api-viewer/apidata.js: ${COMPILEDIR}/docgen
 125         ${COMPILEDIR}/docgen apidata.js >$@
 126
 127 api-viewer/apidoc.js: ${API_VIEWER_FILES}
 128         cat ${API_VIEWER_FILES} >$@.tmp
 129         mv $@.tmp $@
 130
 131 prune-simulator/prune-simulator.js: ${PRUNE_SIMULATOR_JS_SOURCE}
 132         cat ${PRUNE_SIMULATOR_JS_SOURCE} >$@.tmp
 133         mv $@.tmp $@
 134
 135 lto-barcode/lto-barcode-generator.js: ${LTO_BARCODE_JS_SOURCE}
 136         cat ${LTO_BARCODE_JS_SOURCE} >$@.tmp
 137         mv $@.tmp $@
 138
 139 .PHONY: html
 140 html: ${GENERATED_SYNOPSIS} images/proxmox-logo.svg custom.css conf.py ${PRUNE_SIMULATOR_FILES} ${LTO_BARCODE_FILES} ${API_VIEWER_SOURCES}
 141         $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 142         install -m 0644 custom.js custom.css images/proxmox-logo.svg $(BUILDDIR)/html/_static/
 143         install -dm 0755 $(BUILDDIR)/html/prune-simulator
 144         install -m 0644 ${PRUNE_SIMULATOR_FILES} $(BUILDDIR)/html/prune-simulator
 145         install -dm 0755 $(BUILDDIR)/html/lto-barcode
 146         install -m 0644 ${LTO_BARCODE_FILES} $(BUILDDIR)/html/lto-barcode
 147         install -dm 0755 $(BUILDDIR)/html/api-viewer
 148         install -m 0644 ${API_VIEWER_SOURCES} $(BUILDDIR)/html/api-viewer
 149         @echo
 150         @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 151
 152 .PHONY: latexpdf
 153 latexpdf: ${GENERATED_SYNOPSIS}
 154         @echo "Requires python3-sphinx, texlive-xetex, xindy and texlive-fonts-extra"
 155         $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
 156         @echo "Running LaTeX files through xelatex..."
 157         $(MAKE) -C $(BUILDDIR)/latex all-pdf
 158         @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex."
 159
 160 .PHONY: epub3
 161 epub3: ${GENERATED_SYNOPSIS}
 162         $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
 163         @echo
 164         @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
 165
 166 clean:
 167         rm -r -f *~ *.1 ${BUILDDIR} ${GENERATED_SYNOPSIS} api-viewer/apidata.js
 168         rm -f api-viewer/apidoc.js lto-barcode/lto-barcode-generator.js prune-simulator/prune-simulator.js
 169
 170 install_manual_pages: man-pages
 171         install -dm755 $(DESTDIR)$(MAN1DIR)
 172         for i in ${MAN1_PAGES}; do install -m755 ${BUILDDIR}/man/$$i $(DESTDIR)$(MAN1DIR)/ ; done
 173         install -dm755 $(DESTDIR)$(MAN5DIR)
 174         for i in ${MAN5_PAGES}; do install -m755 ${BUILDDIR}/man/$$i $(DESTDIR)$(MAN5DIR)/ ; done
 175
 176 install_html: html
 177         install -dm755 $(DESTDIR)$(DOCDIR)
 178         rsync -a ${BUILDDIR}/html $(DESTDIR)$(DOCDIR)
 179
 180 install_pdf: latexpdf
 181         install -dm755 $(DESTDIR)$(DOCDIR)
 182         install -m 0644 output/latex/ProxmoxBackup.pdf $(DESTDIR)$(DOCDIR)/proxmox-backup.pdf
 183
 184 ifneq ($(filter nodoc,$(DEB_BUILD_PROFILES)),)
 185
 186 install: install_manual_pages
 187
 188 else
 189
 190 install: install_manual_pages install_html install_pdf
 191
 192 endif