[LTP] [PATCH 4/7] doc: documentation.rst: Update build instructions
Petr Vorel
pvorel@suse.cz
Thu Feb 6 15:34:18 CET 2025
Makefile now supports building docs, use it.
Signed-off-by: Petr Vorel <pvorel@suse.cz>
---
doc/developers/documentation.rst | 16 +++-------------
1 file changed, 3 insertions(+), 13 deletions(-)
diff --git a/doc/developers/documentation.rst b/doc/developers/documentation.rst
index 0cd3173fa7..ccee461379 100644
--- a/doc/developers/documentation.rst
+++ b/doc/developers/documentation.rst
@@ -11,23 +11,13 @@ and it's built on top of `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
Building documentation
~~~~~~~~~~~~~~~~~~~~~~
-First of all, to build the documentation we must be sure that all dependencies
-have been installed (please check :master:`doc/requirements.txt` file). Sometimes the
-Linux distros are providing them, but the best way is to use ``virtualenv``
-command as following:
+Before building, make sure you have python3 ``virtualenv`` module installed.
.. code-block:: bash
+ make autotools
+ ./configure
cd doc
-
- # prepare virtual environment
- python3 -m virtualenv .venv
- . .venv/bin/activate
-
- pip install sphinx # usually packaged in distros
- pip install -r requirements.txt
-
- # build documentation
make
Once the procedure has been completed, documentation will be visible at
--
2.47.2
More information about the ltp
mailing list