fantana21 / CppProjectTemplate

Based on cmake-init but adapted to our needs and preferences
MIT License
0 stars 0 forks source link

Generate code documentation #8

Open PatrickKa opened 2 months ago

PatrickKa commented 2 months ago

I don't know which framework or tool to use for that. I want to be able to generate API documentation directly from code, like with special comments and Doxygen or docstrings and Sphinx. However, I also want it to be easy to write documentation pages "manually" (not auto-generated from code, like examples and tutorials) in Markdown, reStructedText, or similar. Finally, it should look nice and ideally only generate static web pages.

Some options to consider:

GitHub Pages is not available with the Free Tier for private repos, but GitLab Pages are, so maybe we can mirror the repo and host the documentation (and code coverage info) there.