Merge branch 'main' into feature/131_update_sphinx_sphinx_needs

.devcontainer/Dockerfile

@@ -40,7 +40,7 @@ RUN apt-get update \
     && rm -rf /var/lib/apt/lists/*
 
 # Update doxygen to latest
-RUN wget -c https://www.doxygen.nl/files/doxygen-1.9.6.linux.bin.tar.gz -O /tmp/doxygen.tar.gz \
+RUN wget -c https://www.doxygen.nl/files/doxygen-1.11.0.linux.bin.tar.gz -O /tmp/doxygen.tar.gz \
     && mkdir -p /tmp/doxygen \
     && tar -xzvf /tmp/doxygen.tar.gz --strip-components=1 -C /tmp/doxygen/ \
     && mv /tmp/doxygen/bin/* /usr/bin \

CHANGELOG.md

@@ -13,6 +13,18 @@
 
 <!--next-version-placeholder-->
 
+## v3.3.10 (2024-07-16)
+
+### Fix
+
+- **toc.py**: Use UTF-8 encoding for reading files (#148)
+
+## v3.3.9 (2024-06-28)
+
+### Fix
+
+- **process.py**: Fix to support Doxygen 1.10 and 1.11 (#141)
+
 ## v3.3.8 (2024-04-30)
 
 ### Fix

doxysphinx/process.py

@@ -114,6 +114,9 @@ def _get_doxy_htmls_to_process_with_hashes(self, doxygen_html_dir: Path) -> Iter
         processed.
         """
         for html_file in doxygen_html_dir.glob("*.html"):
+            # For Doxygen>=1.10.0 this file can be skipped
+            if html_file.name == "doxygen_crawl.html":
+                continue
             rst_file = html_file.with_suffix(".rst")
 
             hash_from_html = hash_blake2b(html_file)

doxysphinx/toc.py

@@ -165,7 +165,7 @@ def _parse_template(self) -> Tuple[str, str]:
         """
         # load html file as string and remove the newline chars
         blueprint = self._source_dir / "index.html"
-        complete_html = blueprint.read_text()
+        complete_html = blueprint.read_text(encoding="UTF-8")
         linearized_html = complete_html.replace("\n", "").replace("\r", "")
 
         # split the html string on the content element