From de4a9b584870ea0904396b7f1e5440e949e878e9 Mon Sep 17 00:00:00 2001 From: Jorge Marques Date: Mon, 16 Sep 2024 18:42:06 -0300 Subject: [PATCH] Recommend upgrading and up aggregate on README.md Recommend upgrading the pip tools to ensure the user is running the latest version of Doctools and the other tools. Update aggregate info, removing monolithic mention in favor of symbolic build. Signed-off-by: Jorge Marques --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2bff7d11..eede0ae2 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,9 @@ Ensure pip is newer than version 23. ``` pip install pip --upgrade ``` -Install the documentation tools. +Install/upgrade the documentation tools. ``` -(cd docs ; pip install -r requirements.txt) +(cd docs ; pip install -r requirements.txt --upgrade) ``` Build the documentation with Sphinx. ``` @@ -19,9 +19,9 @@ Build the documentation with Sphinx. ``` The generated documentation will be available at `docs/_build/html`. -## Building the monolithic documentation +## Building the all documentations -The monolithic version aggregates all ADI's documentation into a single output/webpage. +It's possible to build all ADI's documentation at once. To generate it, considering Doctools is installed, do: ``` adoc aggregate -d docs_output