From 9db2b059eb76eaf51af8e434904caf277b998c99 Mon Sep 17 00:00:00 2001 From: Tamas Ban Date: Mon, 2 Sep 2024 15:04:51 +0200 Subject: [PATCH] fix(docs): fix the example command for doc build Signed-off-by: Tamas Ban Change-Id: I8ee666ee4cd135d09380ce31751ddba9962ff831 --- docs/getting_started/docs-build.rst | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/docs/getting_started/docs-build.rst b/docs/getting_started/docs-build.rst index 50fff5756..54e29dd5f 100644 --- a/docs/getting_started/docs-build.rst +++ b/docs/getting_started/docs-build.rst @@ -37,25 +37,8 @@ Ubuntu): Building rendered documentation ------------------------------- -To install Python dependencies using Poetry: - -.. code:: shell - - poetry install - -Poetry will create a new virtual environment and install all dependencies listed -in ``pyproject.toml``. You can get information about this environment, such as -its location and the Python version, with the command: - -.. code:: shell - - poetry env info - -If you have already sourced a virtual environment, Poetry will respect this and -install dependencies there. - -Once all dependencies are installed, the documentation can be compiled into -HTML-formatted pages from the project root directory by running: +The documentation can be compiled into HTML-formatted pages from the project +root directory by running: .. code:: shell @@ -129,7 +112,7 @@ from project root directory bash -c 'cd /tf-a && apt-get update && apt-get install -y curl plantuml && curl -sSL https://install.python-poetry.org | python3 - && - ~/.local/bin/poetry install && ~/.local/bin/poetry run make doc' + ~/.local/bin/poetry run make doc' The above command fetches the ``sphinxdoc/sphinx`` container from `docker hub`_, launches the container, installs documentation requirements and finally @@ -138,7 +121,7 @@ build process will be placed in: ``docs/build/html``. -------------- -*Copyright (c) 2019-2023, Arm Limited. All rights reserved.* +*Copyright (c) 2019-2024, Arm Limited. All rights reserved.* .. _Sphinx: http://www.sphinx-doc.org/en/master/ .. _Poetry: https://python-poetry.org/docs/