artem-ogre / CDT

Constrained Delaunay Triangulation (C++)
https://artem-ogre.github.io/CDT/
Mozilla Public License 2.0
1.08k stars 136 forks source link

Online documentation contains escaped output #68

Closed HalfVoxel closed 2 years ago

HalfVoxel commented 2 years ago

Looks like something has gone wrong when generating the docs.

image

artem-ogre commented 2 years ago

Hi Aron, thank you for creating this issue.

The docs are generated with Doxygen. It has a feature of using a markdown file as a main page (DOXYGEN_USE_MDFILE_AS_MAINPAGE). This feature is used to to inject README.md into generated docs. Unfortunately this is how Doxygen renders it. I noticed this problem but I don't feel like putting time in resolving this. This could probably be done by either tweaking the README or fixing how Doxygen renders markdown (submitting a fix to Doxygen perhaps). Any help is very welcome.

artem-ogre commented 2 years ago

Finally fixed, just check out this beauty: https://artem-ogre.github.io/CDT/ :)