Skip to content
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

Merged
merged 16 commits into from
Nov 8, 2021
Merged

Add Sphinx documentation #12

merged 16 commits into from
Nov 8, 2021

Conversation

Mandrenkov
Copy link
Collaborator

Context:
It is preferable to have Sphinx documentation available for the XCC in time for the initial public release.

Description of the Change:

  • Added Sphinx documentation to the docs/ directory.
  • Fixed several docstring examples and added Sphinx capabilities to the cached_property decorator.
  • Created a GitHub Actions workflow for building the Sphinx documentation.

Benefits:

  • The XCC documentation is more accessible and consistent with other Xanadu open-source projects.

Possible Drawbacks:
None.

Related GitHub Issues:
None.

@github-actions

This comment has been minimized.

Copy link
Member

@josh146 josh146 left a 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 💯

docs/dev/guide.rst Show resolved Hide resolved
docs/dev/releases.rst Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
xcc/device.py Show resolved Hide resolved
Copy link

@thisac thisac left a comment

Choose a reason for hiding this comment

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

Looks great! Really like the dev guide. It's super-clear! 💯

Not really directly related to this PR, but the settings docs look a bit messy. Not sure how public that needs to be, or if the docstrings can be expanded a bit for it to look better.

Screen Shot 2021-11-05 at 12 19 05 PM

.

docs/Makefile Show resolved Hide resolved
docs/dev/guide.rst Show resolved Hide resolved
@Mandrenkov
Copy link
Collaborator Author

Thank you very much for reviews and suggestions, @josh146 and @thisac!

I've updated the PR accordingly (and added docstrings to the Settings class attributes too).

Copy link
Member

@josh146 josh146 left a 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!

README.rst Outdated Show resolved Hide resolved
@Mandrenkov Mandrenkov merged commit 2cbb8d4 into main Nov 8, 2021
@Mandrenkov Mandrenkov deleted the sc-10957-sphinx branch November 8, 2021 16:02
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.

3 participants