Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding list of missing dependencies to docs #4689

Merged
merged 1 commit into from
Dec 18, 2024
Merged

Adding list of missing dependencies to docs #4689

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/source/user_guide/installation/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ Package Minimum supp
`pandas <https://pypi.org/project/pandas/>`__ 1.5.0
`pooch <https://www.fatiando.org/pooch/>`__ 1.8.1
`posthog <https://posthog.com/>`__ 3.6.5
`pyyaml <https://pyyaml.org/>`__
`platformdirs <https://platformdirs.readthedocs.io/en/latest/>`__
=================================================================== ==========================

.. _install.optional_dependencies:
Expand Down Expand Up @@ -102,13 +104,21 @@ Installable with ``pip install "pybamm[docs]"``
Dependency Minimum Version pip extra Notes
================================================================================================= ================== ================== =======================================================================
`sphinx <https://www.sphinx-doc.org/en/master/>`__ \- docs Sphinx makes it easy to create intelligent and beautiful documentation.
`sphinx_rtd_theme <https://pypi.org/project/sphinx-rtd-theme/>`__ \- docs This Sphinx theme provides a great reader experience for 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.
`sphinx-last-updated-by-git <https://pypi.org/project/sphinx-last-updated-by-git/>`__ \- docs To get the "last updated" time for each Sphinx page from Git.
`nbsphinx <https://nbsphinx.readthedocs.io/en/0.9.5/>`__ \- docs Sphinx extension that provides a source parser for .ipynb files
`ipykernel <https://pypi.org/project/ipykernel/>`__ \- docs Provides the IPython kernel for Jupyter.
`ipywidgets <https://ipywidgets.readthedocs.io/en/latest/>`__ \- docs Interactive HTML widgets for Jupyter notebooks and the IPython kernel.
`sphinx-gallery <https://pypi.org/project/sphinx-gallery/>`__ \- docs Builds an HTML gallery of examples from any set of Python scripts.
`sphinx-hoverxref <https://sphinx-hoverxref.readthedocs.io/en/latest/index.html>`__ \- docs Sphinx extension to show a floating window.
`sphinx-docsearch <https://sphinx-docsearch.readthedocs.io/>`__ \- docs To replaces Sphinx’s built-in search with Algolia DocSearch.
================================================================================================= ================== ================== =======================================================================

.. _install.examples_dependencies:
Expand Down Expand Up @@ -142,7 +152,9 @@ Dependency
`pytest <https://docs.pytest.org/en/stable/>`__ 6.0.0 dev For running the test suites.
`pytest-doctestplus <https://github.com/scientific-python/pytest-doctestplus>`__ \- dev For running doctests.
`pytest-xdist <https://pytest-xdist.readthedocs.io/en/latest/>`__ \- dev For running tests in parallel across distributed workers.
`pytest-mock <https://pytest-mock.readthedocs.io/en/latest/index.html>`__ \- dev Provides a mocker fixture.
`nbmake <https://github.com/treebeardtech/nbmake/>`__ \- dev A ``pytest`` plugin for executing Jupyter notebooks.
`importlib-metadata <https://pypi.org/project/importlib-metadata/>`__ \- dev Used to read metadata from Python packages.
================================================================================ ================== ================== =============================================================

.. _install.cite_dependencies:
Expand Down
Loading