Fix doc build #863
Merged
Fix doc build #863
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Due to sphinx-doc/sphinx#10701 documentation build of dpctl started failing with release of Sphinx 5.1.0. The exception raised is triggered by missing docstrings for property class attributes. This change adds such docstrings and now local documentation build goes through as expected.
|
View rendered docs @ https://intelpython.github.io/dpctl/pulls/863/index.html |
|
Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With release of Sphinx 5.1.0 the
dpctldocumentation build started failing due to sphinx-doc/sphinx#10701 with an exception in sphinx.The exception is tripped by missing or empty docstrings for
propertyclass attributes as pointed out by @yaricoptic.Update in Sphinx also revealed two typos in Doxygen annotations which this PR also fixed.