public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
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	[thread overview]
Message-ID: <20260219155509.601533-1-m.sandoval@proxmox.com> (raw)

If the binaries have not been built then make -C docs throws an error
which is not obvious.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 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 <https://doc.rust-lang.org/rustc/platform-support.html>`__
+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





             reply	other threads:[~2026-02-19 15:54 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-19 15:54 Maximiliano Sandoval [this message]
2026-02-19 16:12 ` applied: " Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260219155509.601533-1-m.sandoval@proxmox.com \
    --to=m.sandoval@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal