Introduction

This procedure covers the action to install LaTeX and Visual Studio Code in the host, to develop the documentation needed for BOA.

Pre-conditions

1. Procedure Install BOA in development mode from scratch has been successfully executed.

Procedure

1. Install TexLive and Texlive-formats-extra packages for generating PDF files using TEX:

sudo apt install texlive
sudo apt install texlive-formats-extra

1. Install Latexmk package for generating PDF files within Visual Studio:

sudo apt install latexmk

1. Install Visual Studio:

sudo snap install --classic code

1. Open Visual Studio Code and go to extensions section (Ctrl + Shift + X) and search for "LaTex Workshop" by James Yu and install it.

   

2. Go to File/Preferences/Settings, then extensions LaTeX and search for “out dir” and change the path to %DIR%/build, this way will have output files inside "build" folder and will be more organized.

   

3. Now you can create the documentation associated with each module inside the corresponding tex folder.

   Build LateX project using Ctrl + Alt+ B or Ctrl + S in the doc.tex

   This will create a "build" folder that will contain a doc.pdf file, which is a temporary PDF.

   

   Note: Use (Ctrl + Alt+ V) to view the PDF.

4. For generating the final version:

   Important: Close Visual Studio Code before continuing with the procedure.

   1. Go inside the docker container:

docker exec -it -e HOME=/home/s2boa -u s2boa boa_app_dev /bin/bash

1. Go to the corresponding tex folder (for example, for generating the documentation for EBOA):

cd /eboa/doc/tex/

1. Execute the generate_doc.sh command (this will include also the auto-generated documentation for the code):

./generate_doc.sh -f EBOA_0.1.0.pdf -k

---

category.storage-team category.confluence