From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 0AACBC4167B for ; Fri, 30 Dec 2022 18:12:21 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id 2FE24850A9; Fri, 30 Dec 2022 19:12:19 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (1024-bit key; unprotected) header.d=konsulko.com header.i=@konsulko.com header.b="OjJOYzaV"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id 6CADC850A9; Fri, 30 Dec 2022 19:12:17 +0100 (CET) Received: from mail-qt1-x831.google.com (mail-qt1-x831.google.com [IPv6:2607:f8b0:4864:20::831]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id E91A684F66 for ; Fri, 30 Dec 2022 19:12:13 +0100 (CET) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=konsulko.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=trini@konsulko.com Received: by mail-qt1-x831.google.com with SMTP id a16so17649120qtw.10 for ; Fri, 30 Dec 2022 10:12:13 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=konsulko.com; s=google; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=1Y+iDxLz7ylfusWiHzDKJnTjnM+nUpyZQruJ7d8T6H8=; b=OjJOYzaVWyioOLKSDx03Yt21nhQMa+ejqohuQCnnnbn+Rc6mgfXSV5ItKhSQNc162k w7/Fn2vBxGimzrX0o9Of4cIjFWw8KFjRZYCCkWwqg2PuESt8K01mYj6Suih8Lf9y9ZPM xGU0tDlttWN+o1vAd/3mDSpY6Ma/6G8kVLqm8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=in-reply-to:content-disposition:mime-version:references:message-id :subject:cc:to:from:date:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=1Y+iDxLz7ylfusWiHzDKJnTjnM+nUpyZQruJ7d8T6H8=; b=F896kLlf7K3dkUtqTgl6tlUNNF3FbodlFSPPqXfCMI0EBAIrYy8yYS7b95kqMtbNPk 8v33Oix+fGdGtNMwucd14veWDpwTdDVx0Og8EW1nUqpo2CNl9iBq3faK+/xzbCgVT5bD 7uL9V9I6PFbKEP8jY91FITFeC9EF+zejHlS0ZOeHQQLWbqQiaFPxff3kUD6B/diONyNh Q8J/LqMl8eOf65fK/bFu2XXmaSggvVrwBdBs/PQiYmKWw9zIv+svjkFGxkPARuTzQU9A O82r1r1mDkn9L5gYuBv8YkbYPuYAfFxuMoTKKZWbOmhKvboAy4hExKbjaSBn5jBZu4pm +YoQ== X-Gm-Message-State: AFqh2kofrseydPZ3NEtiDltg9dQDVPBs4AqXa/ENxxKanX0mJQfgfwKL 45QCHwmieE4L2giDAPnTeKJExSGmctZjp1jE7NM= X-Google-Smtp-Source: AMrXdXtPAAhFfirneNrbxd7Q2pFxQy5GhdtNFmrWPwIWy50F3TZgELpGumzo/Dy0hlDletA+t3k39A== X-Received: by 2002:ac8:4153:0:b0:3a7:ee95:cc44 with SMTP id e19-20020ac84153000000b003a7ee95cc44mr45279174qtm.43.1672423932784; Fri, 30 Dec 2022 10:12:12 -0800 (PST) Received: from bill-the-cat (2603-6081-7b00-6400-a5a5-eb4c-bea2-121a.res6.spectrum.com. [2603:6081:7b00:6400:a5a5:eb4c:bea2:121a]) by smtp.gmail.com with ESMTPSA id ff13-20020a05622a4d8d00b003a5fb681ae7sm13516945qtb.3.2022.12.30.10.12.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 30 Dec 2022 10:12:12 -0800 (PST) Date: Fri, 30 Dec 2022 13:12:10 -0500 From: Tom Rini To: Simon Glass Cc: Heinrich Schuchardt , Maxim Cournoyer , u-boot@lists.denx.de Subject: Re: [PATCH 1/1] doc: building documentation Message-ID: <20221230181210.GE3787616@bill-the-cat> References: <20221230040745.16619-1-heinrich.schuchardt@canonical.com> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="ZRNUOYyy+Hmp9i9J" Content-Disposition: inline In-Reply-To: X-Clacks-Overhead: GNU Terry Pratchett X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.6 at phobos.denx.de X-Virus-Status: Clean --ZRNUOYyy+Hmp9i9J Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Fri, Dec 30, 2022 at 11:51:15AM -0600, Simon Glass wrote: > Hi Heinrich, >=20 > On Thu, 29 Dec 2022 at 22:08, Heinrich Schuchardt > wrote: > > > > Provide a man-page describing how to build the U-Boot documentation. > > > > Signed-off-by: Heinrich Schuchardt > > --- > > doc/build/documentation.rst | 90 +++++++++++++++++++++++++++++++++++++ > > doc/build/index.rst | 1 + > > 2 files changed, 91 insertions(+) > > create mode 100644 doc/build/documentation.rst > > > > diff --git a/doc/build/documentation.rst b/doc/build/documentation.rst > > new file mode 100644 > > index 0000000000..896264dd7c > > --- /dev/null > > +++ b/doc/build/documentation.rst > > @@ -0,0 +1,90 @@ > > +.. SPDX-License-Identifier: GPL-2.0+: > > + > > +Building documentation > > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > > + > > +The U-Boot documentation is based on the Sphinx documentation generato= r. > > + > > +HTML documentation > > +------------------ > > + > > +The *htmldocs* target is used to build the HTML documentation. It uses= the > > +`Read the Docs Sphinx theme `_. > > + > > +.. code-block:: bash > > + > > + # Create Python environment 'myenv' > > + python3 -m venv myenv > > + # Activate the Python environment > > + . myenv/bin/activate > > + # Install build requirements > > + python3 -m pip install -r doc/sphinx/requirements.txt > > + # Build the documentation > > + make htmldocs > > + # Deactivate the Python environment > > + deactivate > > + # Display the documentation in a graphical web browser > > + x-www-browser doc/output/index.html >=20 > If this is necessary then it is a bit of a sad indictment on Python. I > would use: >=20 > pip3 install -r doc/sphinx/requirements.txt > make htmldocs Which part, exactly? Using a virtual environment is I believe a normal best practice and "python3 -m pip" rather than "pip3" I assume is another best practice for portability. Then maybe the final step should say "Review" not "Display" ? --=20 Tom --ZRNUOYyy+Hmp9i9J Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQGzBAABCgAdFiEEGjx/cOCPqxcHgJu/FHw5/5Y0tywFAmOvKfoACgkQFHw5/5Y0 tywm9gwAuR9qUGmm80QUWs8t3sNwehJhvyUVKaCp/t6bxC5UFjyo2jxhqWpesWoL cirWp7kdE6BcIGwe4ofjteUupB5V3+nErdzn+A9SZYhY9/0YkhVWklUZkyja3r66 RkuLaJDjyy3qeZJ0WaEe3wCUpsAyQXpL4gtR8vTHrmrIfzHRDQJPDf8cDv6ntKem i3z9mXr8agzwJbnPm5OUndn22SpZk9RxRsxG5WAznrQWZv73m/sI+SRcOCfff21U kAcMbaPpt/yhNDC0Rl/l9BwBcloVwVJMQsXAwM1oHybUXQDWlQRiRxOY+Wh5UoAG TkfVZuA2I+46ecmRngtTlVYctP43Z1WRTWnztbar3KDhg8Fi1IXaJ7NN6thPR4cO mK0d5/whjeiQqs2w28ZUcvBRRJLaaE6DDdBoi6RkZCUtMeeVd6pU9pPeaVpVvBp7 uaxhinRW4gyHKGtKmUN6vvjdU7vM//3+D1859YoumsoXFbAKm/IbaXPxF/DDdGK1 VLCjbiTm =NR4N -----END PGP SIGNATURE----- --ZRNUOYyy+Hmp9i9J--