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

Docs improvements #399

Merged
merged 6 commits into from
May 8, 2021
Merged

Docs improvements #399

merged 6 commits into from
May 8, 2021

Conversation

scarrazza
Copy link
Member

Here we include some extra subsections to simplify the navigation from the user point of view.

@codecov
Copy link

codecov bot commented Apr 29, 2021

Codecov Report

Merging #399 (9531b36) into simtf (acf7c19) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##             simtf      #399   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           80        80           
  Lines        12731     12731           
=========================================
  Hits         12731     12731           
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/qibo/abstractions/gates.py 100.00% <ø> (ø)
src/qibo/hamiltonians.py 100.00% <100.00%> (ø)

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 acf7c19...9531b36. Read the comment docs.

@scarrazza
Copy link
Member Author

@stavros11 I would like to merge this before completing the docs in #398, could you please let me know if you agree?

Copy link
Member

@stavros11 stavros11 left a comment

Choose a reason for hiding this comment

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

Thanks for writing this, I agree with having a seperate section for each model / gate / Hamiltonian, as this makes it easier for the user to navigate the docs through the side contents. Some small comments below.

Also remember to change the base branch to simtf before merging this.

doc/source/qibo.rst Show resolved Hide resolved
doc/source/qibo.rst Outdated Show resolved Hide resolved
doc/source/qibo.rst Outdated Show resolved Hide resolved
@scarrazza scarrazza changed the base branch from distsort to simtf May 7, 2021 13:47
@scarrazza scarrazza merged commit 78cdf48 into simtf May 8, 2021
@scarrazza scarrazza deleted the updocs branch July 10, 2021 17:01
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