Lokasi ngalangkungan proxy:   [ UP ]  
[Ngawartoskeun bug]   [Panyetelan cookie]                
Skip to content

📝 Add Documentation#24

Merged
DRovara merged 9 commits into
mainfrom
docs/read-the-docs
Sep 25, 2024
Merged

📝 Add Documentation#24
DRovara merged 9 commits into
mainfrom
docs/read-the-docs

Conversation

@DRovara

@DRovara DRovara commented Sep 25, 2024

Copy link
Copy Markdown
Collaborator

Description

This PR introduces an extensive RTD documentation for the project. It includes a description of the installation procedure, tips on how to use the different forms of the framework, and an extensive reference of the c++ and python code.

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.

@codecov-commenter

codecov-commenter commented Sep 25, 2024

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.8%. Comparing base (f451fa0) to head (4e8a0d6).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main     #24   +/-   ##
=====================================
  Coverage   98.8%   98.8%           
=====================================
  Files          9       9           
  Lines       1616    1617    +1     
  Branches     296     296           
=====================================
+ Hits        1598    1599    +1     
  Misses        18      18           
Flag Coverage Δ
cpp 98.8% <100.0%> (ø)
python 100.0% <100.0%> (ø)
Files with missing lines Coverage Δ
src/backend/dd/DDSimDebug.cpp 98.5% <100.0%> (ø)
src/mqt/debugger/__init__.py 100.0% <100.0%> (ø)

@DRovara DRovara merged commit 4344992 into main Sep 25, 2024
@DRovara DRovara deleted the docs/read-the-docs branch September 25, 2024 14:50
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