Skip to content

Commit a6e02b2

Browse files
authored
🐛 Entirely disable PDF build (#660)
## Description #659 did not resolve the issue described there. One option in `readthedocs.yml` was still missed. This PR solves this issue. Additionally, this PR enables the concatenation of class and `__init__` docstrings on the Python side. ## 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 focused and relevant to this change. - [ ] I have added appropriate tests that cover the new/changed functionality. - [x] I have updated the documentation to reflect these changes. - [x] I have added entries to the changelog for any noteworthy additions, changes, fixes or removals. - [x] I have added migration instructions to the upgrade guide (if needed). - [x] The changes follow the project's style guidelines and introduce no new warnings. - [x] The changes are fully tested and pass the CI checks. - [x] I have reviewed my own code changes. --------- Signed-off-by: Yannick Stade <[email protected]>
1 parent a901d60 commit a6e02b2

File tree

5 files changed

+18
-5
lines changed

5 files changed

+18
-5
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: 2
22

33
formats:
4-
- pdf
4+
# - pdf
55
- htmlzip
66

77
build:

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ This project adheres to [Semantic Versioning], with the exception that minor rel
77

88
## [Unreleased]
99

10+
## [3.1.2] - 2025-05-27
11+
12+
### Fixed
13+
14+
- 🐛 Entirely deactivate PDF export in documentation build ([#660]) ([**@ystade**])
15+
- 📝 Append the docstring for the `__init__` method to the class docstring in the documentation ([#660]) ([**@ystade**])
16+
1017
## [3.1.1] - 2025-05-27
1118

1219
### Fixed
@@ -56,14 +63,16 @@ _📚 Refer to the [GitHub Release Notes] for previous changelogs._
5663

5764
<!-- Version links -->
5865

59-
[unreleased]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.1...HEAD
66+
[unreleased]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.2...HEAD
67+
[3.1.2]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.1...v3.1.2
6068
[3.1.1]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.0...v3.1.1
6169
[3.1.0]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.0.0...v3.1.0
6270
[3.0.0]: https://github.com/munich-quantum-toolkit/qmap/compare/v2.8.0...v3.0.0
6371
[2.8.0]: https://github.com/munich-quantum-toolkit/qmap/releases/tag/v2.8.0
6472

6573
<!-- PR links -->
6674

75+
[#660]: https://github.com/munich-quantum-toolkit/qmap/pulls/660
6776
[#659]: https://github.com/munich-quantum-toolkit/qmap/pulls/659
6877
[#624]: https://github.com/munich-quantum-toolkit/qmap/pulls/624
6978
[#621]: https://github.com/munich-quantum-toolkit/qmap/pulls/621

UPGRADING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document describes breaking changes and how to upgrade. For a complete list
44

55
## [Unreleased]
66

7-
## [3.1.1]
7+
## [3.1.0]
88

99
This minor release initiates the efforts to re-structure the Python bindings and make them more modular.
1010
Even tough this is not a breaking change, it is worth mentioning to developers of MQT QMAP that all Python code (except tests) has been moved to the top-level `python` directory.
@@ -43,6 +43,6 @@ Most modern operating systems should have this version available in their packag
4343
Alternatively, CMake can be conveniently installed from PyPI using the [`cmake`](https://pypi.org/project/cmake/) package.
4444

4545
[MQT SyReC]: https://github.com/cda-tum/mqt-syrec
46-
[unreleased]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.1...HEAD
47-
[3.1.1]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.0.0...v3.1.1
46+
[unreleased]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.1.0...HEAD
47+
[3.1.0]: https://github.com/munich-quantum-toolkit/qmap/compare/v3.0.0...v3.1.0
4848
[3.0.0]: https://github.com/munich-quantum-toolkit/qmap/compare/v2.8.0...v3.0.0

docs/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,7 @@ def format_url(self, _e: Entry) -> HRef: # noqa: PLR6301
153153
"show-module-summary",
154154
]
155155
autoapi_keep_files = True
156+
autoapi_python_class_content = "both"
156157
add_module_names = False
157158
toc_object_entries_show_parents = "hide"
158159
python_use_unqualified_type_names = True

python/mqt/qmap/na/zoned.pyi

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ from mqt.core.ir import QuantumComputation
1212

1313
class ZonedNeutralAtomArchitecture:
1414
"""Class representing a Zoned Neutral Atom Architecture."""
15+
1516
@classmethod
1617
def from_json_file(cls, filename: str) -> ZonedNeutralAtomArchitecture:
1718
"""Create an architecture from a JSON file.
@@ -41,6 +42,7 @@ class ZonedNeutralAtomArchitecture:
4142

4243
class RoutingAgnosticCompiler:
4344
"""MQT QMAP's routing-agnostic Zoned Neutral Atom Compiler."""
45+
4446
def __init__(
4547
self,
4648
arch: ZonedNeutralAtomArchitecture,
@@ -95,6 +97,7 @@ class RoutingAgnosticCompiler:
9597

9698
class RoutingAwareCompiler:
9799
"""MQT QMAP's routing-aware Zoned Neutral Atom Compiler."""
100+
98101
def __init__(
99102
self,
100103
arch: ZonedNeutralAtomArchitecture,

0 commit comments

Comments
 (0)