Documentation revamp - #601
Draft
matulni wants to merge 1 commit into
Draft
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #601 +/- ##
=======================================
Coverage 89.29% 89.29%
=======================================
Files 49 49
Lines 7799 7799
=======================================
Hits 6964 6964
Misses 835 835 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR proposes a skeleton for the tutorial section of the documentation.
Feel free to complete the proposed sections or improve the documentation layout by opening PRs on this draft PR.
To render the documentation locally, go to the
graphix/graphix/docsdirectory and runTODO list
Writing tutorials
graph_mbqcmeasurement_calculustranspilationflowspattern_standardizationspace_minimizationpauli_removalpattern_simulationcircuit_extractionsymbolictype_safetyOther sections
Design
For future PRs
Concerning the API, for now we can just add the modules as they appear in the tutorials, even if they are not logically ordered, so that links are clickable.
Useful links
Sphinx documentation
Furo theme documentation
www.writethedocs.org/guide/writing/beginners-guide-to-docs