Merge branch 'feature/update-documentation-for-building-the-documentation' into 'main'

Add documentation for building the documentation

See merge request belle2/software/display!12

Author: GiacomoXT

docs/Makefile

@@ -19,3 +19,4 @@ The source code for the Belle II Event Display with Phoenix project is stored in
    ./developer/modules.rst
    ./developer/event_display.rst
    ./developer/server.rst
+   ./developer/documentation.rst

docs/make.bat

@@ -0,0 +1,31 @@
+Building the Documentation
+==========================
+
+To build this documentation and view it, please follow the steps below.
+
+1. Create a Python virtual environment:
+
+   .. code-block:: console
+
+      $ python3 -m venv display-env
+
+2. Activate the virtual environment:
+
+   .. code-block:: console
+
+      $ source display-env/bin/activate
+
+3. Install **Sphinx** and all the other required packages:
+
+   .. code-block:: console
+
+      $ pip3 install -r requirements-docs.txt
+
+4. Build the documentation:
+
+   .. code-block:: console
+
+      $ sphinx-build docs/source/ docs/build
+
+5. Open the documentatio with your web browser. The entry point to the documentation is
+   ``docs/build/index.html``.

docs/requirements.txt

@@ -5,7 +5,7 @@ Installation
 
 For developers, to set up the local environment, please follow the steps below.
 
-1. **Install Node.js** on your system. You can download the latest version of Node.js from the
+1. Install **Node.js** on your system. You can download the latest version of Node.js from the
    `official website`_.
 
    Note that the recommended version of Angular CLI (see below) requires a minimum Node.js version
@@ -14,13 +14,13 @@ For developers, to set up the local environment, please follow the steps below.
 .. _official website: https://nodejs.org/en/download
 
 
-2. **Install Angular CLI** globally by running the following command:
+2. Install **Angular CLI** globally:
 
    .. code-block:: console
 
       $ npm install -g @angular/[email protected]
 
-3. **Clone the git repository** by running the following command:
+3. Clone the Git repository:
 
    .. code-block:: console
 
@@ -32,8 +32,18 @@ For developers, to set up the local environment, please follow the steps below.
 
       $ cd display
 
-5. Run ``npm install`` to install the necessary dependencies.
+5. Install the necessary dependencies:
 
-6. Run ``npm start`` or ``ng serve`` to start the development server.
+   .. code-block:: console
+
+      $ npm ci
+
+6. Start the development server:
+
+   .. code-block:: console
+
+      $ npm start
 
-7. Navigate to ``http://localhost:4200/`` in your web browser to view the application.
+7. Navigate to ``http://localhost:4200/`` in your web browser to view the application. In case the
+   port ``4200`` is already used by other services, the application reports which port to use via
+   log message.