28 setup doxygen doc - Githubissues

u413-284-si / webserv

This project is about setting up a http web server, providing a static website.

MIT License

0 stars 0 forks source link

28 setup doxygen doc #39

Closed gwolf-011235 closed 1 month ago

gwolf-011235 commented 1 month ago

Create Doxyfile

is used to create doxygen documentation
A template Doxyfile can be generated by doxygen -g
To show difference between template and ours use doxygen -x doc/Doxyfile
Landing page is README.md of repo
Doxygen version in dev container is 1.9.4 (bookworm): package

Add submodule doxygen-awesome-css

is used to create more stylish documentation; is fixed at latest stable release
is referenced in Doxyfile as HTML_EXTRA_STYLESHEET and HTML_EXTRA_FILES
changes the design of documentation
also adds functionality (darkmode, fragment copy button, paragraph link) which are activated in doc/header.html

Implements github action Doxygen GitHub Pages Deploy Action

automatically create doxygen documentation and deploy to branch GH-pages
is executed by push on main
executes on ubuntu latest (noble). This has doxygen version 1.9.8 - package. This should not be a problem since backwards compatible. If it is dev container will be updated.

Add package graphviz to dev container

graphviz is used by doxygen to create svg graphs
documentation can be created as a test in dev container

Delete doubled main

in the project root directory was an old copy of main.cpp -> deleted

Closes #28