search

open-simulation-platform / libcosim

OSP C++ co-simulation library
https://open-simulation-platform.github.io/libcosim
Mozilla Public License 2.0
61 stars 10 forks source link

Add an introductory page to the API documentation #617

Closed kyllingstad closed 4 years ago

kyllingstad commented 4 years ago

The contents of docs/main_page.md will be the first thing the user sees upon browsing the API documentation. That is, it will fill the current void below the menu here (substituting "Introduction" in place of the "libcosim Documentation" heading). All symbols link to the appropriate place in the API documentation, by Doxygen magic.

This fixes #616.

markaren commented 4 years ago

Content looks good. I can't build and test the doc myself, so I can't vouch for that.