🐛 Deactivate PDF Export for Documentation and Prepare Patch Release #659
Conversation
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
ystade
commented
May 27, 2025
ystade
commented
May 27, 2025
Signed-off-by: Yannick Stade <[email protected]>
ystade
added a commit
that referenced
this pull request
May 27, 2025
## 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]>
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.
Description
Curly braces in the Python code on the zoned neutral atom compiler page of the documentation cause an issue in the PDF export via LaTeX on readthedocs. Until we find another solution, this PR deactivates the PDF export for the documentation.
Additionally, it corrects two typos on the page for the zoned neutral atom compiler.
This PR also prepares the corresponding path release.
Checklist: