Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a a documentation browsable online living inside the codebase #6

Open
yacineMahdid opened this issue Jan 19, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@yacineMahdid
Copy link
Contributor

Even though we won't have much, having the boiler plate of the documentation will allow us to easily extend it as we go. As time goes on this task will become less and less appealing.

@yacineMahdid yacineMahdid added the documentation Improvements or additions to documentation label Jan 19, 2021
@yacineMahdid yacineMahdid self-assigned this Jan 19, 2021
@yacineMahdid yacineMahdid added this to To do in Foundation 🏗️ via automation Jan 19, 2021
@yacineMahdid
Copy link
Contributor Author

It seems that Doxygen is good choice for this type of project however after some digging the trio of Doxygen + Breathe + Sphinx is more useful. Plus we can host that documentation on readthedocs for free which is very good!

Here is a link to get started that I will follow: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

1 participant