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

📝 New and improved project documentation #589

Merged
merged 40 commits into from
Apr 20, 2024
Merged

Conversation

burgholzer
Copy link
Member

Description

This PR brings some quite substantial documentation improvements.
This include extensive documentation for all classes, methods and functions that are part of the Python package.
It also includes updates to the general documentation building pipeline that make it easier to write notebooks for docs purely in Markdown and provide nicer LaTeX output.

This should set the new best practice for writing documentation within the MQT.

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>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer added documentation Improvements or additions to documentation enhancement New feature or request Core Anything related to the Core library and IR python Anything related to Python code labels Apr 16, 2024
@burgholzer burgholzer added this to the MQT Core milestone Apr 16, 2024
@burgholzer burgholzer self-assigned this Apr 16, 2024
Signed-off-by: burgholzer <burgholzer@me.com>
Copy link

codecov bot commented Apr 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.4%. Comparing base (5649e0c) to head (0b69f4c).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main    #589   +/-   ##
=====================================
  Coverage   91.4%   91.4%           
=====================================
  Files        131     131           
  Lines      14091   14091           
  Branches    2250    2250           
=====================================
  Hits       12885   12885           
  Misses      1206    1206           
Flag Coverage Δ *Carryforward flag
cpp 91.1% <ø> (ø) Carriedforward from 123b9c7
python 99.5% <100.0%> (ø)

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

Files Coverage Δ
src/mqt/core/__init__.py 100.0% <ø> (ø)
src/mqt/core/__main__.py 100.0% <100.0%> (ø)
src/mqt/core/_commands.py 100.0% <ø> (ø)
src/mqt/core/evaluation.py 99.4% <100.0%> (ø)
src/mqt/core/io.py 100.0% <ø> (ø)
src/mqt/core/plugins/qiskit.py 99.5% <100.0%> (+<0.1%) ⬆️

Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
Signed-off-by: burgholzer <burgholzer@me.com>
@burgholzer burgholzer enabled auto-merge (squash) April 20, 2024 10:28
@burgholzer burgholzer linked an issue Apr 20, 2024 that may be closed by this pull request
@burgholzer burgholzer merged commit f6815fa into main Apr 20, 2024
28 checks passed
@burgholzer burgholzer deleted the docs-improvements branch April 20, 2024 10:53
burgholzer pushed a commit to cda-tum/mqt-qmap that referenced this pull request May 2, 2024
## Description

This PR improves the documentation by updating the year in the
copyright, updating a link to an external documentation and making the
MQT logo clickable.

All changes are taken from the PR cda-tum/mqt-core#589.

## Checklist:

<!---
This checklist serves as a reminder of a couple of things that ensure
your pull request will be merged swiftly.
-->

- [x] The pull request only contains commits that are related to it.
- [x] I have added appropriate tests and documentation.
- [x] I have made sure that all CI jobs on GitHub pass.
- [x] The pull request introduces no new warnings and follows the
project's style guidelines.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Core Anything related to the Core library and IR documentation Improvements or additions to documentation enhancement New feature or request python Anything related to Python code
Projects
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

📝 Better API Docs
1 participant