From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [PATCH 3/3] doc: Update building docs section
Date: Fri, 19 Apr 2024 14:42:21 +0200 [thread overview]
Message-ID: <20240419124221.207445-3-pvorel@suse.cz> (raw)
In-Reply-To: <20240419124221.207445-1-pvorel@suse.cz>
* Use python3 as a binary (most of distros still have python reserved for
python2).
* Mention sphinx can be used from package.
* While at it, replace 'source' with '.' (shorter, although most of the
developers use shell which support source bashism, let's not encourage
to use it).
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
doc/developers/documentation.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst
index 825495c50..0fbf5d49b 100644
--- a/doc/developers/documentation.rst
+++ b/doc/developers/documentation.rst
@@ -21,10 +21,10 @@ command as following:
cd doc
# prepare virtual enviroment
- python -m virtualenv .venv
- source .venv/bin/activate
+ python3 -m virtualenv .venv
+ . .venv/bin/activate
- pip install sphinx
+ pip install sphinx # usually packaged in distros
pip install -r requirements.txt
# build documentation
--
2.43.0
--
Mailing list info: https://lists.linux.it/listinfo/ltp
next prev parent reply other threads:[~2024-04-19 12:42 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-19 12:42 [LTP] [PATCH 1/3] doc: Bump minimal supported kernel to 4.4 Petr Vorel
2024-04-19 12:42 ` [LTP] [PATCH 2/3] doc: Clarify that the only public CI testing is build only Petr Vorel
2024-04-19 13:18 ` Andrea Cervesato via ltp
2024-04-19 13:53 ` Petr Vorel
2024-05-09 10:04 ` Cyril Hrubis
2024-05-09 10:23 ` Petr Vorel
2024-05-09 13:34 ` Petr Vorel
2024-04-19 12:42 ` Petr Vorel [this message]
2024-04-19 13:07 ` [LTP] [PATCH 3/3] doc: Update building docs section Andrea Cervesato via ltp
2024-04-20 1:57 ` [LTP] [PATCH 1/3] doc: Bump minimal supported kernel to 4.4 Li Wang
2024-05-09 9:55 ` Cyril Hrubis
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=20240419124221.207445-3-pvorel@suse.cz \
--to=pvorel@suse.cz \
--cc=ltp@lists.linux.it \
/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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).