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.

Sign up for GitHub

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

Jump to bottom

Write docs #13

Open
newlawrence opened this issue Jul 7, 2016 · 3 comments
Open

Write docs #13

newlawrence opened this issue Jul 7, 2016 · 3 comments
Labels
help wanted requirement

Comments

@newlawrence
Copy link
Owner

I'll comment properly the whole source code, but I'll appreciate any help with documentation generators.
@newlawrence
Copy link
Owner Author

Reminder to myself. Lets take a look on Doxygen library for this task.

@newlawrence
Copy link
Owner Author

It seems that Sphinx can be used to generate documentation for C++, as can be seen here. In the same article, the author also explains how to integrate it with CMake which is ideal for this project.

@newlawrence
Copy link
Owner Author

From Calculate 2 and above this is now a requirement; no first stable version will be released until docs are written.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted requirement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@newlawrence