aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPetr Vorel <pvorel@suse.cz>2024-04-19 14:42:21 +0200
committerPetr Vorel <petr.vorel@gmail.com>2024-05-06 23:03:25 +0200
commit8cb61291ff932e6df72c15084761e29a6bdc27a1 (patch)
tree21dbc24d8a87f6d3cb855e9cf56b204799b7e640
parent0a682f1af42d8d261202821be580fe26d17ee9b7 (diff)
downloadltp-8cb61291ff932e6df72c15084761e29a6bdc27a1.tar.gz
doc: Update building docs section
* 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). Link: https://lore.kernel.org/ltp/20240419124221.207445-3-pvorel@suse.cz/ Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com> Signed-off-by: Petr Vorel <pvorel@suse.cz>
-rw-r--r--doc/developers/documentation.rst6
1 files 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