Add installation troubleshooting (#379)

* Add installation troubleshooting * Refer to phonopy troubleshooting
stfc · Feb 12, 2025 · c97046e · c97046e
1 parent 47569eb
commit c97046e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/source/user_guide/troubleshooting.rst b/docs/source/user_guide/troubleshooting.rst
@@ -2,6 +2,14 @@
 Troubleshooting
 ===============
 
+Installation
+------------
+
+When installing ``janus-core``, CMake errors can occur when building ``phonopy``, often related to the CXX compiler.
+
+Please refer to their `installation documentation <http://phonopy.github.io/phonopy/install.html#missing-or-unknown-cxx-compiler>`_ for guidance.
+
+
 Carbon tracking
 ---------------
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -86,8 +86,9 @@ docs = [
     "sphinx<9.0.0,>=8.0.2",
     "sphinxcontrib-contentui<1.0.0,>=0.2.5",
     "sphinxcontrib-details-directive<1.0,>=0.1",
+    "sphinx-autodoc-typehints<3.0.0,>=2.5.0",
+    "sphinx-collapse>=0.1.3",
     "sphinx-copybutton<1.0.0,>=0.5.2",
-    "sphinx-autodoc-typehints<3.0.0,>=2.5.0"
 ]
 
 pre-commit = [