Skip to content

✨📝 Revamp documentation - #614

Merged
burgholzer merged 2 commits into
mainfrom
revamp-documentation
Mar 17, 2025
Merged

✨📝 Revamp documentation#614
burgholzer merged 2 commits into
mainfrom
revamp-documentation

Conversation

@burgholzer

Copy link
Copy Markdown
Member

Description

This PR finally modernizes the documentation for the project and brings it up to date with the latest best practices.
Future bindings documentation now directly goes into the pyqmap.pyi file instead of bindings.cpp.
Furthermore, symbols from mqt.qmap.pyqmap are no longer re-exported as part of mqt.qmap.

Fixes #591

Checklist:

  • The pull request only contains commits that are related to it.
  • I have added appropriate tests and documentation.
  • I have made sure that all CI jobs on GitHub pass.
  • The pull request introduces no new warnings and follows the project's style guidelines.

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer added the documentation Improvements or additions to documentation label Mar 16, 2025
@burgholzer burgholzer self-assigned this Mar 16, 2025
@github-project-automation github-project-automation Bot moved this to In Progress in MQT Mar 16, 2025
@github-project-automation github-project-automation Bot moved this to In Progress in MQT Compilation Mar 16, 2025
@burgholzer
burgholzer enabled auto-merge March 17, 2025 00:15
@burgholzer
burgholzer merged commit 9fb895b into main Mar 17, 2025
@burgholzer
burgholzer deleted the revamp-documentation branch March 17, 2025 00:35
@github-project-automation github-project-automation Bot moved this from In Progress to Done in MQT Compilation Mar 17, 2025
@github-project-automation github-project-automation Bot moved this from In Progress to Done in MQT Mar 17, 2025
@codecov

codecov Bot commented Mar 17, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.0%. Comparing base (7b4980f) to head (3d374c6).
Report is 3 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main    #614     +/-   ##
=======================================
- Coverage   91.0%   91.0%   -0.1%     
=======================================
  Files        103     103             
  Lines      10869   10868      -1     
  Branches    1861    1861             
=======================================
- Hits        9899    9898      -1     
  Misses       970     970             
Flag Coverage Δ *Carryforward flag
cpp 90.8% <ø> (ø) Carriedforward from 7b4980f
python 96.7% <100.0%> (-0.1%) ⬇️

*This pull request uses carry forward flags. Click here to find out more.

Files with missing lines Coverage Δ
src/mqt/qmap/__init__.py 100.0% <ø> (ø)
src/mqt/qmap/clifford_synthesis.py 93.2% <ø> (ø)
src/mqt/qmap/compile.py 100.0% <ø> (ø)
src/mqt/qmap/plugins/qiskit.py 100.0% <100.0%> (ø)
src/mqt/qmap/subarchitectures.py 95.4% <ø> (ø)
🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@coderabbitai coderabbitai Bot mentioned this pull request Oct 15, 2025
8 tasks
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.

🐛Beginners tutorial: FakeLondon does not exist in qiskit 1.3.2

1 participant