kribakarans/doxygen repository overview

⁠Doxygen server in docker

⁠Build doxygen documentaion for your projects

1. Pull the doxygen docker image
   docker pull kribakarans/doxygen:latest

2. Run the doxygen server. The copied projects are available at /host directory.
   docker run -d -p 9596:80 -v $HOME/Public:/host kribakarans/doxygen

3. Copy the projects repository to the shared folder. By default it is $HOME/Public.
   cp -rvf <project-source-repo> $HOME/Public

4. Login to the server
   docker exec -it doxygen bash
   

5. Run mkdox command in the project root directory to build the doxygen documentation.
   Enter the prompt input values and note the URL to explore the documentation.

6. Explore the project at http://localhost:9596/project-name⁠