tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs/backup-protocol.rst: add backup protocol docs

This commit is contained in:
Dietmar Maurer 2019-06-04 17:33:12 +02:00
parent 22e5aa1d3e
commit 177db84b82
3 changed files with 21 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/Makefile
View File

@ -7,7 +7,8 @@ COMPILEDIR := ../target/debug
endif endif
GENERATED_SYNOPSIS := \ GENERATED_SYNOPSIS := \
proxmox-backup-client/synopsis.rst proxmox-backup-client/synopsis.rst \
backup-protocol-api.rst
MANUAL_PAGES := \ MANUAL_PAGES := \
proxmox-backup-proxy.1 \ proxmox-backup-proxy.1 \
@ -29,6 +30,10 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
all: ${MANUAL_PAGES} all: ${MANUAL_PAGES}
# Extract backup protocol docs
backup-protocol-api.rst: ${COMPILEDIR}/dump-backup-api
${COMPILEDIR}/dump-backup-api >$@
# Build manual pages using rst2man # Build manual pages using rst2man
proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client proxmox-backup-client/synopsis.rst: ${COMPILEDIR}/proxmox-backup-client
@ -48,20 +53,20 @@ html: ${GENERATED_SYNOPSIS}
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
.PHONY: latexpdf .PHONY: latexpdf
latexpdf: latexpdf: ${GENERATED_SYNOPSIS}
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..." @echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf $(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
.PHONY: epub3 .PHONY: epub3
epub3: epub3: ${GENERATED_SYNOPSIS}
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3
@echo @echo
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3."
clean: clean:
rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} rm -r -f *~ *.1 */synopsis.rst ${BUILDDIR} backup-protocol-api.rst
install: ${MANUAL_PAGES} install: ${MANUAL_PAGES}
install -dm755 $(DESTDIR)$(MAN1DIR) install -dm755 $(DESTDIR)$(MAN1DIR)

11
docs/backup-protocol.rst Normal file
View File

@ -0,0 +1,11 @@
Backup Protocol
===============
Backup Protocol API
-------------------
.. include:: backup-protocol-api.rst

1
docs/index.rst
View File

@ -22,6 +22,7 @@ Welcome to Proxmox Backup's documentation!
command-syntax.rst command-syntax.rst
file-formats.rst file-formats.rst
backup-protocol.rst
glossary.rst glossary.rst
* :ref:`genindex` * :ref:`genindex`