📚🩹 Fix rendering of Result with nbsphinx (workaround) (#1244)

* 📚🩹 Fix rendering of Result with nbsphinx (workaround)

* 🤔 Use conda build env on RTD to control pandoc version

* 🩹 Fix wrong number of sections closed in hack

docs/environment.yml

@@ -0,0 +1,11 @@
+name: RTD-env
+channels:
+  - conda-forge
+dependencies:
+  # Python interpreter
+  - python=3.10
+  - pandoc>=2.19.2
+  - pip
+  - pip:
+      - -r requirements.txt
+      - ..

glotaran/project/result.py

@@ -244,7 +244,15 @@ def markdown(
             if wrap_model_in_details is False:
                 result_table = f"{result_table}\n\n{model_md}"
             else:
-                result_table = f"{result_table}\n\n<br><details>\n\n{model_md}\n</details>"
+                # The section part is just a hack to generate properly rendering docs due to a bug
+                # in sphinx which causes a wrong tag opening and closing order of html tags
+                # Since model_md contains 2 heading levels we need to close 2 sections
+                result_table = (
+                    f"{result_table}\n\n<br><details>\n\n{model_md}\n"
+                    f"{'</section>'*(2)}"
+                    "</details>"
+                    f"{'<section>'*(2)}"
+                )
 
         return MarkdownStr(result_table)
 

readthedocs.yml

@@ -8,10 +8,7 @@ sphinx:
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.10"
+    python: "mambaforge-4.10"
 
-python:
-  install:
-    - requirements: docs/requirements.txt
-    - method: pip
-      path: .
+conda:
+  environment: docs/environment.yml