From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 4107B1FF13C for ; Thu, 19 Feb 2026 16:54:45 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 2AD8A1D49A; Thu, 19 Feb 2026 16:55:46 +0100 (CET) From: Maximiliano Sandoval To: pbs-devel@lists.proxmox.com Subject: [PATCH backup] readme: Add instructions on how to build the docs Date: Thu, 19 Feb 2026 16:54:27 +0100 Message-ID: <20260219155509.601533-1-m.sandoval@proxmox.com> X-Mailer: git-send-email 2.47.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1771516500616 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.087 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: H4HKSWSRGHRROBLD6SPFEPGP72RO7VKK X-Message-ID-Hash: H4HKSWSRGHRROBLD6SPFEPGP72RO7VKK X-MailFrom: m.sandoval@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: If the binaries have not been built then make -C docs throws an error which is not obvious. Signed-off-by: Maximiliano Sandoval --- README.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.rst b/README.rst index 3059ba387..9f3d359cb 100644 --- a/README.rst +++ b/README.rst @@ -65,6 +65,23 @@ You are now able to build using the Makefile or cargo itself, e.g.:: # # or for a non-package build # cargo build --all --release +Building the online documentation +================================= + +The online documentation can be build in HTML format as follows. First build the +required binaries:: + + make docs + +The previous step is only necessary once. Then the online documentation can be +built or regenerated with:: + + make -C docs DEB_HOST_RUST_TYPE=x86_64-unknown-linux-gnu html + +With the `rust target `__ +of the host. The resulting documentation will be at ``docs/output/html/`` and +can be open with your browser of choice or, e.g. ``xdg-open``. + Design Notes ************ -- 2.47.3