]> git.proxmox.com Git - proxmox-backup.git/blobdiff - docs/Makefile
docs: add prototype sphinx extension for online help
[proxmox-backup.git] / docs / Makefile
index 34ec8809e66fe323754b435aa19aa4082c593249..8d1e8a1b4eaa13bb3978a38752bdd139f43ab236 100644 (file)
@@ -28,7 +28,6 @@ COMPILEDIR := ../target/debug
 SPHINXOPTS    += -t devbuild
 endif
 
-
 # Sphinx internal variables.
 ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) .
 
@@ -68,6 +67,12 @@ 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}
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html