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

Redesign documentation #25

Merged
merged 18 commits into from
Apr 13, 2020
Merged

Redesign documentation #25

merged 18 commits into from
Apr 13, 2020

Conversation

mariaschuld
Copy link
Contributor

@mariaschuld mariaschuld commented Apr 8, 2020

Turn the cirq documentation into Xanadu style. It is recommended to locally build the documentation for code review.

We do currently not have a lot of content, but this can be the basis of growing the plugin.

README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/devices/overview.rst Outdated Show resolved Hide resolved
README.rst Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
doc/devices/overview.rst Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Apr 8, 2020

Codecov Report

Merging #25 into master will increase coverage by 0.62%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master      #25      +/-   ##
==========================================
+ Coverage   98.70%   99.33%   +0.62%     
==========================================
  Files           6        6              
  Lines         155      151       -4     
==========================================
- Hits          153      150       -3     
+ Misses          2        1       -1     
Impacted Files Coverage Δ
pennylane_cirq/_version.py 100.00% <100.00%> (ø)
pennylane_cirq/cirq_device.py 100.00% <100.00%> (ø)
pennylane_cirq/simulator_device.py 100.00% <100.00%> (+1.61%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ddeaea...e818ee1. Read the comment docs.

doc/directives.py Outdated Show resolved Hide resolved
Copy link
Contributor

@antalszava antalszava left a comment

Choose a reason for hiding this comment

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

Looks awesome, thank you so much @mariaschuld! 😊 The changes related to old QubitDevice methods and the new analytic_probability method would be important, along with removing the attributes that render empty within the docs table (if agreed upon).

Left some suggestions apart from those. At times these refer to multiple places, left a marker at one or two places (these are mostly systematic things).

Also, would it be easy to add a bit of space to the bottom of the page where the Class diagrams are shown? (It's okay if not 😊 )

@antalszava
Copy link
Contributor

The JavaScript formattings seem to be off for CodeFactor 🤔

@josh146
Copy link
Member

josh146 commented Apr 9, 2020

Have updated the codefactor settings to ignore javascript files!

mariaschuld and others added 5 commits April 9, 2020 08:42
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
Co-Authored-By: antalszava <antalszava@gmail.com>
@mariaschuld
Copy link
Contributor Author

I think I caught most of your suggestions, and updated to reflect the latest qiskit polish as well.

@josh146 I wonder why CodeFactor still complains about js files?

@mariaschuld mariaschuld merged commit 686c21c into master Apr 13, 2020
@mariaschuld mariaschuld deleted the redesign_docs branch April 13, 2020 07:28
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