Skip to content

Docstring fixes #385

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

Merged
merged 3 commits into from
Apr 14, 2021
Merged

Docstring fixes #385

merged 3 commits into from
Apr 14, 2021

Conversation

diptorupd
Copy link
Contributor

Final cleanups and improvements to docstrings before releasing 0.7.0.

@diptorupd
Copy link
Contributor Author

@oleksandr-pavlyk I polished up the docstrings of SyclContext. The rendered docs are published at https://intelpython.github.io/dpctl/latest/docfiles/dpctl_pyapi/SyclContext.html. Would be great if we could polish up more of the classes.

Also, you can generate the Sphinx docs just for the Python API omitting the C API and avoiding the issues you were facing with doxyrest. Here's the "how-to": https://github.com/diptorupd/dpctl/blob/doc-improvement/docs/README.md#build-only-sphinx-for-python-api.

Copy link
Contributor

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great @diptorupd

I will try to do the same to SyclQueue.

@oleksandr-pavlyk oleksandr-pavlyk merged commit 77c81e2 into master Apr 14, 2021
@oleksandr-pavlyk oleksandr-pavlyk deleted the docstring-fixes branch April 14, 2021 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants