[LTP] [PATCH 3/3] doc: Update building docs section

Petr Vorel pvorel@suse.cz
Fri Apr 19 14:42:21 CEST 2024


* 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



More information about the ltp mailing list