Formatting and minor fixes

pybamm-team · Jul 5, 2023 · 63524b4 · 63524b4
1 parent 432b02b
commit 63524b4
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 41 deletions.
diff --git a/docs/source/user_guide/installation/index.rst b/docs/source/user_guide/installation/index.rst
@@ -66,7 +66,7 @@ Package                                                          Minimum support
 `SciPy <https://docs.scipy.org/doc/scipy/>`__                    2.8.2
 `pandas <https://pandas.pydata.org/docs/>`__                     0.24.0
 `CasADi <https://web.casadi.org/docs/>`__                        3.6.0
-`xarray <https://docs.xarray.dev/en/stable/>`__                  2023.04.0
+`Xarray <https://docs.xarray.dev/en/stable/>`__                  2023.04.0
 ================================================================ ==========================
 
 .. _install.optional_dependencies:
@@ -88,12 +88,12 @@ Plot dependencies
 
 Installable with ``pip install "pybamm[plot]"``
 
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==================================================================
 Dependency                                                  Minimum Version    pip extra          Notes
-=========================================================== ================== ================== ===================================================================================================================================================================================
-`imageio <https://imageio.readthedocs.io/en/stable/>`__     2.9.0              plot               Handles diverse image data formats, including animated, volumetric, and scientific formats.
-`Matplotlib <https://matplotlib.org/stable/>`__             2.0.0              plot               To plot various battery models, and analyzing battery performance.
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==================================================================
+`imageio <https://imageio.readthedocs.io/en/stable/>`__     2.9.0              plot               For generating simulation GIFs.
+`matplotlib <https://matplotlib.org/stable/>`__             2.0.0              plot               To plot various battery models, and analyzing battery performance.
+=========================================================== ================== ================== ================================================================== 
 
 .. _install.docs_dependencies:
 
@@ -102,18 +102,18 @@ Docs dependencies
 
 Installable with ``pip install "pybamm[docs]"``
 
-================================================================================================= ================== ================== ===================================================================================================================================================================================
+================================================================================================= ================== ================== =======================================================================
 Dependency                                                                                        Minimum Version    pip extra          Notes
-================================================================================================= ================== ================== ===================================================================================================================================================================================
+================================================================================================= ================== ================== =======================================================================
 `sphinx <https://www.sphinx-doc.org/en/master/>`__                                                1.5.0              docs               Sphinx makes it easy to create intelligent and beautiful documentation.
-`pydata-sphinx-theme <https://pydata-sphinx-theme.readthedocs.io/en/stable/>`__                   \-                  docs               A clean, Bootstrap-based Sphinx theme
-`sphinx_design <https://sphinx-design.readthedocs.io/en/latest/>`__                               \-                  docs               A sphinx extension for designing
-`sphinx-copybutton <https://sphinx-copybutton.readthedocs.io/en/latest/>`__                       \-                  docs               To copy codeblocks
-`myst-parser <https://myst-parser.readthedocs.io/en/latest/>`__                                   \-                  docs               For technical & scientific documentation.
-`sphinx-inline-tabs <https://sphinx-inline-tabs.readthedocs.io/en/latest/>`__                     \-                  docs               Add inline tabbed content to your Sphinx documentation.
-`sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io/en/latest/>`__                 \-                  docs               For BibTeX citations
-`sphinx-autobuild <https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html>`__   \-                  docs               For re-building docs once triggered
-================================================================================================= ================== ================== ===================================================================================================================================================================================
+`pydata-sphinx-theme <https://pydata-sphinx-theme.readthedocs.io/en/stable/>`__                   \-                 docs               A clean, Bootstrap-based Sphinx theme.
+`sphinx_design <https://sphinx-design.readthedocs.io/en/latest/>`__                               \-                 docs               A sphinx extension for designing.
+`sphinx-copybutton <https://sphinx-copybutton.readthedocs.io/en/latest/>`__                       \-                 docs               To copy codeblocks.
+`myst-parser <https://myst-parser.readthedocs.io/en/latest/>`__                                   \-                 docs               For technical & scientific documentation.
+`sphinx-inline-tabs <https://sphinx-inline-tabs.readthedocs.io/en/latest/>`__                     \-                 docs               Add inline tabbed content to your Sphinx documentation.
+`sphinxcontrib-bibtex <https://sphinxcontrib-bibtex.readthedocs.io/en/latest/>`__                 \-                 docs               For BibTeX citations.
+`sphinx-autobuild <https://sphinx-extensions.readthedocs.io/en/latest/sphinx-autobuild.html>`__   \-                 docs               For re-building docs once triggered.
+================================================================================================= ================== ================== =======================================================================
 
 .. _install.examples_dependencies:                 
 
@@ -122,11 +122,11 @@ Examples dependencies
 
 Installable with ``pip install "pybamm[examples]"``
 
-================================================================================ ================== ================== ===================================================================================================================================================================================
+================================================================================ ================== ================== ================================
 Dependency                                                                       Minimum Version    pip extra          Notes
-================================================================================ ================== ================== ===================================================================================================================================================================================
-`jupyter <https://docs.jupyter.org/en/latest/>`__                                \-                  examples           For example notebooks rendering.
-================================================================================ ================== ================== ===================================================================================================================================================================================
+================================================================================ ================== ================== ================================
+`jupyter <https://docs.jupyter.org/en/latest/>`__                                \-                 examples           For example notebooks rendering.
+================================================================================ ================== ================== ================================
 
 .. _install.dev_dependencies:
 
@@ -135,12 +135,12 @@ Dev dependencies
 
 Installable with ``pip install "pybamm[dev]"``
 
-================================================================================ ================== ================== ===================================================================================================================================================================================
+================================================================================ ================== ================== =============================================================
 Dependency                                                                       Minimum Version    pip extra          Notes
-================================================================================ ================== ================== ===================================================================================================================================================================================
-`pre-commit <https://pre-commit.com/index.html>`__                               \-                  dev                For managing and maintaining multi-language pre-commit hooks.
-`black <https://black.readthedocs.io/en/stable/>`__                              \-                  dev                For code formatting.
-================================================================================ ================== ================== ===================================================================================================================================================================================
+================================================================================ ================== ================== =============================================================
+`pre-commit <https://pre-commit.com/index.html>`__                               \-                 dev                For managing and maintaining multi-language pre-commit hooks.
+`black <https://black.readthedocs.io/en/stable/>`__                              \-                 dev                For code formatting.
+================================================================================ ================== ================== =============================================================
 
 .. _install.cite_dependencies:
 
@@ -149,11 +149,11 @@ Cite dependencies
 
 Installable with ``pip install "pybamm[cite]"``
 
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== =========================================
 Dependency                                                  Minimum Version    pip extra          Notes
-=========================================================== ================== ================== ===================================================================================================================================================================================
-`pybtex <https://docs.pybtex.org/>`__                       0.24.0             cite               BibTeX-compatible bibliography processor
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== =========================================
+`pybtex <https://docs.pybtex.org/>`__                       0.24.0             cite               BibTeX-compatible bibliography processor.
+=========================================================== ================== ================== =========================================
 
 .. _install.latexify_dependencies:
 
@@ -162,11 +162,11 @@ Latexify dependencies
 
 Installable with ``pip install "pybamm[latexify]"``
 
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== =========================
 Dependency                                                  Minimum Version    pip extra          Notes
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== =========================
 `sympy <https://docs.sympy.org/latest/index.html>`__        1.8.0              latexify           For symbolic mathematics.
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== =========================
 
 .. _install.bpx_dependencies:
 
@@ -175,11 +175,11 @@ bpx dependencies
 
 Installable with ``pip install "pybamm[bpx]"``
 
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==========================
 Dependency                                                  Minimum Version    pip extra          Notes
-=========================================================== ================== ================== ===================================================================================================================================================================================
-`bpx <https://pypi.org/project/bpx/>`__                     \-                  bpx                Battery Parameter eXchange
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==========================
+`bpx <https://pypi.org/project/bpx/>`__                     \-                 bpx                Battery Parameter eXchange
+=========================================================== ================== ================== ==========================
 
 .. _install.tqdm_dependencies:
 
@@ -188,11 +188,11 @@ tqdm dependencies
 
 Installable with ``pip install "pybamm[tqdm]"``
 
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==================
 Dependency                                                  Minimum Version    pip extra          Notes
-=========================================================== ================== ================== ===================================================================================================================================================================================
-`tqdm <https://tqdm.github.io/>`__                          \-                  tqdm               For logging loops.
-=========================================================== ================== ================== ===================================================================================================================================================================================
+=========================================================== ================== ================== ==================
+`tqdm <https://tqdm.github.io/>`__                          \-                 tqdm               For logging loops.
+=========================================================== ================== ================== ==================
 
 Full installation guide
 -----------------------             

diff --git a/noxfile.py b/noxfile.py
@@ -114,7 +114,7 @@ def run_tests(session):
 @nox.session(name="docs", reuse_venv=True)
 def build_docs(session):
     envbindir = session.bin
-    session.install("-e", ".[docs]")
+    session.install("-e", ".[all,docs]")
     with session.chdir("docs/"):
         session.run(
             "sphinx-autobuild",