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 #114

Merged
merged 17 commits into from
Sep 13, 2022
Merged

📝 Docs #114

merged 17 commits into from
Sep 13, 2022

Conversation

pehamTom
Copy link
Member

@pehamTom pehamTom commented Sep 9, 2022

Setup readthedocs for QMAP.

@codecov
Copy link

codecov bot commented Sep 9, 2022

Codecov Report

Merging #114 (f31bb8e) into main (ddc39c4) will not change coverage.
The diff coverage is n/a.

@@          Coverage Diff          @@
##            main    #114   +/-   ##
=====================================
  Coverage   91.2%   91.2%           
=====================================
  Files         20      20           
  Lines       1731    1731           
  Branches     414     414           
=====================================
  Hits        1580    1580           
  Misses       151     151           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@burgholzer burgholzer changed the title Docs 📝 Docs Sep 12, 2022
@burgholzer burgholzer added the documentation Improvements or additions to documentation label Sep 12, 2022
Copy link
Member

@burgholzer burgholzer left a comment

Choose a reason for hiding this comment

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

Thanks a lot for all your work. This is a great start for adding proper documentation to this project. I have a couple of direct suggestions and a couple more requests where I believe the current draft can be improved. Of course, everything is up for discussion, so please feel free to reply to the respective comments with other suggestions.

One more thing that I could not annotate in the files themselves: Now that there is proper documentation for the project: Could you also refactor the README to match the (minimalistic) style of QCEC and DDSIM?
Basically, all information from the readme should in some form be present in the documentation. If it is, it can be removed from the README.

docs/source/Publications.rst Outdated Show resolved Hide resolved
docs/source/Mapping.rst Outdated Show resolved Hide resolved
docs/source/Mapping.rst Show resolved Hide resolved
docs/source/Mapping.rst Outdated Show resolved Hide resolved
docs/source/Mapping.rst Outdated Show resolved Hide resolved
docs/source/library/Architecture.rst Outdated Show resolved Hide resolved
docs/source/library/Architecture.rst Outdated Show resolved Hide resolved
docs/source/library/Architecture.rst Show resolved Hide resolved
docs/source/library/Architecture.rst Outdated Show resolved Hide resolved
docs/source/library/Architecture.rst Outdated Show resolved Hide resolved
Copy link
Member

@burgholzer burgholzer left a comment

Choose a reason for hiding this comment

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

Just did another round of review. Couple of further requests. Nothing major.

docs/source/Mapping.rst Outdated Show resolved Hide resolved
docs/source/Mapping.rst Show resolved Hide resolved
docs/source/Mapping.rst Show resolved Hide resolved
docs/source/Publications.rst Show resolved Hide resolved
docs/source/install/Developers.rst Outdated Show resolved Hide resolved
docs/source/install/Developers.rst Outdated Show resolved Hide resolved
docs/source/Mapping.rst Show resolved Hide resolved
docs/source/Mapping.rst Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants