Skip to content

Commit db228ec

Browse files
authored
💚 fix the RtD doxygen run (#912)
## Description This PR fixes the doxygen run that is performed on RtD. This would previously fail silently because it could not create the respective directory. This also adds a release note to prepare for the imminent patch release. ## 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. --------- Signed-off-by: burgholzer <[email protected]>
1 parent ce0911b commit db228ec

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
77

88
## [Unreleased]
99

10+
## [3.0.1] - 2025-04-07
11+
12+
_Fix PyPI project metadata as well as doxygen build on RtD._
13+
1014
## [3.0.0] - 2025-04-06
1115

1216
_If you are upgrading: please see [`UPGRADING.md`](UPGRADING.md#300)._
@@ -64,6 +68,7 @@ _📚 Refer to the [GitHub Release Notes](https://github.com/munich-quantum-tool
6468

6569
[PEP 639]: https://peps.python.org/pep-0639/
6670
[PEP 735]: https://peps.python.org/pep-0735/
67-
[unreleased]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.0...HEAD
71+
[unreleased]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.1...HEAD
72+
[3.0.1]: https://github.com/munich-quantum-toolkit/core/compare/v3.0.0...v3.0.1
6873
[3.0.0]: https://github.com/munich-quantum-toolkit/core/compare/v2.7.0...v3.0.0
6974
[2.7.0]: https://github.com/munich-quantum-toolkit/core/releases/tag/v2.7.0

docs/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,8 +171,11 @@ def format_url(self, _e: Entry) -> HRef: # noqa: PLR6301
171171

172172
read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
173173
if read_the_docs_build:
174-
subprocess.call("doxygen", shell=True) # noqa: S602, S607
175-
subprocess.call("mkdir api/cpp & breathe-apidoc -o api/cpp -m -f -T _build/doxygen/xml/", shell=True) # noqa: S602, S607
174+
subprocess.call("mkdir -p _build/doxygen && doxygen", shell=True) # noqa: S602, S607
175+
subprocess.call( # noqa: S602
176+
"mkdir -p api/cpp && breathe-apidoc -o api/cpp -m -f -g namespace _build/doxygen/xml/", # noqa: S607
177+
shell=True,
178+
)
176179

177180
# -- Options for HTML output -------------------------------------------------
178181
html_theme = "furo"

0 commit comments

Comments
 (0)