Skip to main content

OCUDU Documentation

This directory contains the automated API documentation generation (Doxygen) for OCUDU code.

Structure​

docs/
├── .env                     # env file for docker-compose
├── docker-compose.yml       # Docker services for documentation
├── doxygen/                 # Doxygen project
└── README.md                # This file

Docker Services​

Usage​

Builds doxygen locally with

docker compose -f docs/docker-compose.yml up

You can select another doxygen target using the environmental variable

DOXYGEN_TARGET=doxygen-support docker compose -f docs/docker-compose.yml up

Environment Variables​

To run the docker-compose, you may need to adjust the variables defined in the .env file.

  • UID/GID: Your user/group IDs for file permissions in Docker