From 3a9988638b31233f0dcf41e1e0ef1b91ef87eb35 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Mon, 6 Jul 2020 14:40:58 +0200 Subject: [PATCH] docs: move todolist to own document, don't link in release build It is always build for html, but not linked if the devbuild tag isn't set. This tag is set in the Makefile if the $(BUILD_MODE) variable isn't "release". Signed-off-by: Thomas Lamprecht --- docs/Makefile | 15 +++++++++------ docs/index.rst | 11 +++++++++-- 2 files changed, 18 insertions(+), 8 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index d7682e54..34ec8809 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -1,11 +1,5 @@ include ../defines.mk -ifeq ($(BUILD_MODE), release) -COMPILEDIR := ../target/release -else -COMPILEDIR := ../target/debug -endif - GENERATED_SYNOPSIS := \ proxmox-backup-client/synopsis.rst \ proxmox-backup-client/catalog-shell-synopsis.rst \ @@ -26,6 +20,15 @@ SPHINXOPTS = SPHINXBUILD = sphinx-build BUILDDIR = output +ifeq ($(BUILD_MODE), release) +COMPILEDIR := ../target/release +SPHINXOPTS += -t release +else +COMPILEDIR := ../target/debug +SPHINXOPTS += -t devbuild +endif + + # Sphinx internal variables. ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . diff --git a/docs/index.rst b/docs/index.rst index 57229948..61c44a98 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,8 +11,6 @@ published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". -.. todolist:: - .. toctree:: :maxdepth: 3 @@ -36,5 +34,14 @@ in the section entitled "GNU Free Documentation License". glossary.rst GFDL.rst +.. only:: html and devbuild + + .. toctree:: + :maxdepth: 2 + :caption: Developer Appendix + + todos.rst + + * :ref:`genindex`