9. Documentation

9.1. Build with Docker

1. Clone the C-PAT repository from GitHub.

2. Navigate to /docs folder of the repository.

3. Build the Docker image using the following command: docker build -t sphinx-w-requirements .

4. Run the Docker image using the following command: docker run --rm -v "$(pwd):/docs" sphinx-w-requirements

5. The build product is located in _build in the docs directory.

Alternatively, you can run the build.sh script located in the /docs directory of the repository. This script will build the Docker image and run the container, generating the documentation.

9.2. Build with Python

To build the documentation locally:

1. Clone the C-PAT repository from GitHub.

2. Install Python

3. Install Sphinx pip install sphinx

4. Navigate to /docs folder of the repository.

5. Install the documentation build requirements pip install -r requirements.txt

6. Depending on the OS you are using, build the documentation using make.bat or the Makefile, and specify html as the format. Windows PowerShell example: ./make html

By default, the build product is located in _build in the docs directory.