adonmo / meos

Mobility Engine, Open Source
https://adonmo.github.io/meos/
MIT License
21 stars 3 forks source link

Better C++ docs #10

Closed chaitan94 closed 4 years ago

chaitan94 commented 4 years ago

Right now we are using doxygen out of the box - which is fine, although, honestly I think it could be better - both in terms of usability and looks. I have two different approaches in mind, which I think are worth considering:

Approach 1. Use MCSS theme

Approach 2. Integrate with sphinx/readthedocs

Right now I am leaned a bit towards Approach 1. Any ideas/suggestions/contributions towards this would be greatly appreciated.

chaitan94 commented 4 years ago

Went ahead with Approach 1. Has been implemented in https://github.com/adonmo/meos/commit/d17cedfc04f2ef13456fbd352741adf2fc54bada.

The new documentation is live at: https://meos.netlify.app/

Also, a similar change has been contributed to the upstream template on which the base CMake code structure of MEOS was based on: https://github.com/TheLartians/ModernCppStarter/pull/49.