diff mbox series

[3/3] doc: Update building docs section

Message ID 20240419124221.207445-3-pvorel@suse.cz
State Accepted
Headers show
Series [1/3] doc: Bump minimal supported kernel to 4.4 | expand

Commit Message

Petr Vorel April 19, 2024, 12:42 p.m. UTC
* 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(-)

Comments

Andrea Cervesato April 19, 2024, 1:07 p.m. UTC | #1
Hi!

Reviewed-by: Andrea Cervesato <andrea.cervesato@suse.com>

On 4/19/24 14:42, Petr Vorel wrote:
> * 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

Andrea
diff mbox series

Patch

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