Skip to content

Commit

Permalink
Replace - by \-
Browse files Browse the repository at this point in the history
  • Loading branch information
@arjxn-py
arjxn-py committed Jun 30, 2023
1 parent 0704bef commit f091e27
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/source/user_guide/installation/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,13 @@ 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:
Expand All @@ -125,7 +125,7 @@ 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:
Expand All @@ -138,8 +138,8 @@ 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:
Expand Down Expand Up @@ -178,7 +178,7 @@ 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:
Expand All @@ -191,7 +191,7 @@ 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
Expand Down

0 comments on commit f091e27

Please sign in to comment.