-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add Sphinx documentation #12
Conversation
This comment has been minimized.
This comment has been minimized.
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.
Looks great @Mandrenkov, thanks for putting this together! I left one ver minor comment, re: including the readme in the documentation, but apart from that 💯
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.
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.
@Mandrenkov this PR is 💯 Above and beyond what I was expected for bare-boned docs!
Context:
It is preferable to have Sphinx documentation available for the XCC in time for the initial public release.
Description of the Change:
docs/
directory.cached_property
decorator.Benefits:
Possible Drawbacks:
None.
Related GitHub Issues:
None.