Added pandoc installation instruction (pybamm-team#3985)

* Added pandoc installation instruction * Correct reason for installing pandoc Co-authored-by: Agriya Khetarpal <[email protected]> --------- Co-authored-by: Eric G. Kratz <[email protected]> Co-authored-by: Agriya Khetarpal <[email protected]>
linjing-gz-gd · Apr 10, 2024 · e8d56e8 · e8d56e8
1 parent 85219cd
commit e8d56e8
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/docs/source/user_guide/installation/install-from-source.rst b/docs/source/user_guide/installation/install-from-source.rst
@@ -31,26 +31,27 @@ To install PyBaMM, you will need:
 - A C compiler (ex: ``gcc``).
 - A Fortran compiler (ex: ``gfortran``).
 - ``graphviz`` (optional), if you wish to build the documentation locally.
+- ``pandoc`` (optional) to convert the example Jupyter notebooks when building the documentation.
 
 You can install the above with
 
 .. tab:: Ubuntu/Debian
 
 	.. code:: bash
 
-		sudo apt install python3.X python3.X-dev libopenblas-dev gcc gfortran graphviz cmake
+		sudo apt install python3.X python3.X-dev libopenblas-dev gcc gfortran graphviz cmake pandoc
 
 	Where ``X`` is the version sub-number.
 
 .. tab:: MacOS
 
 	.. code:: bash
 
-		brew install python openblas gcc gfortran graphviz libomp cmake
+		brew install python openblas gcc gfortran graphviz libomp cmake pandoc
 
 .. note::
 
-    If you are using some other linux distribution you can install the equivalent packages for ``python3, cmake, gcc, gfortran, openblas``.
+    If you are using some other linux distribution you can install the equivalent packages for ``python3, cmake, gcc, gfortran, openblas, pandoc``.
 
     On Windows, you can install ``graphviz`` using the `Chocolatey <https://chocolatey.org/>`_ package manager, or follow the instructions on the `graphviz website <https://graphviz.org/download/>`_.