-
Notifications
You must be signed in to change notification settings - Fork 160
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
[Docs] Rewrite build documentation #510
[Docs] Rewrite build documentation #510
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great to me!
Since at least 2 approving reviews are required to merge this pull request and 1 done, @hjabird who would be the 2nd here? |
I hope that @dnhsieh-intel, @mkrainiuk, @vmalia or @akabalov will take some interest! I'm hoping for feedback from more than two people ideally however since this is a very public-facing PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for doing this, this will be a great improvement when it is done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the great care and thoroughness in your response to my review. I'm looking forward to seeing these docs merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the contribution! I still need some time to go through it.
Here are somethings I noticed:
- Should we say "building oneMKL interface library", "building oneMKL interfaces library", or just "building oneMKL interfaces"?
- For CMake options, we have
yes/no
,True/False
,ON/OFF
. I think it would be better to unify the usage.
Thank you very much for comments! |
* Rewrites the build documentation * Separates DPC++ and AdaptiveCpp documentation * Adds section on consuming with CMake
…fiddle with titles
…nal clarifications
73d3510
to
e06b9b9
Compare
I've rebased on some recent changes, so the rendered html now looks prettier: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for the delay. Thanks again for the great work!
Ah, I forgot one thing. The "fixes: #459" in the description will close the issue automatically after this PR is merged. GitHub doesn't recognize partially fixes. |
…sparse BLAS; `clang++`
@dnhsieh-intel how is this looking to you? I'm running a tutorial tomorrow, so if you think its ready I'd be delighted if we got this merged. |
* Rewrites build documentation * Splits documentation into several files * Adds docs for using with CMake.
Description
This PR completely rewrites the build documentation in an attempt to make it easier to follow and less intimidating. It separates out the DPC++ and AdaptiveCpp builds, and also adds a section on using oneMKL with CMake.
contributes to the solution of #459