-
Notifications
You must be signed in to change notification settings - Fork 29
Sphinx and Doxygen documentation #140
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
Conversation
- Fix sphinx code generation bug - Add a temporary link to the raw doxygen files in index.rst
Pushed the static pages to gh-pages. You can see them rendered here https://intelpython.github.io/dpctl/. Somehow they render incorrectly. |
Trying to compile with
|
I would like to propose URL like for SDC and add @Alexander-Makaryev what are URLs for dpNP and daal4py? |
Resolved merge conflict:
|
I have fixed incorrect rendering. Just created .nojekyll file. See this commit 99e7f9b and its commit message. |
@oleksandr-pavlyk Can you review the PR once more? I have fixed the CMakeLists.txt issue you found. I will like to merge this as the first step to making generating docs easier. |
@oleksandr-pavlyk Actually let me move the changes to |
@oleksandr-pavlyk Can you please review the changes I made to the Cython files to add |
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.
LGTM.
Adds an initial infrastructure to generate API documentation. Documentation generation works fine locally. Tried publishing them on gh-pages with not so great results.
I think Sphix+breathe+exhale+doxygen works much nicer than raw doxygen. Although, some information that is on doxygen is not showing up in sphinx using exhale and breathe.
Checkout xtensor documentation to see a more polished example than what I have managed to do thus far using breathe and exhale.