Skip to content

Commit e4f85a2

Browse files
azelcerreneeotten
authored andcommittedOct 13, 2021
DOC: update documentation/requirements for development packages
1 parent 8ad7e28 commit e4f85a2

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed
 

‎doc/installation.rst

+16-11
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ Downloading and Installation
55
.. _lmfit github repository: https://github.com/lmfit/lmfit-py
66
.. _python: https://python.org
77
.. _scipy: https://scipy.org/scipylib/index.html
8-
.. _numpy: http://numpy.org/
8+
.. _numpy: https://numpy.org/
99
.. _pytest: https://pytest.org/
10+
.. _pytest-cov: https://github.com/pytest-dev/pytest-cov
1011
.. _emcee: https://emcee.readthedocs.io/
1112
.. _pandas: https://pandas.pydata.org/
1213
.. _jupyter: https://jupyter.org/
@@ -24,7 +25,8 @@ Downloading and Installation
2425
.. _Pillow: https://python-pillow.org/
2526
.. _sphinx-gallery: https://sphinx-gallery.github.io/stable/index.html
2627
.. _flaky: https://github.com/box/flaky
27-
28+
.. _SymPy: https://www.sympy.org/
29+
.. _Latexmk: https://ctan.org/pkg/latexmk/
2830

2931
Prerequisites
3032
~~~~~~~~~~~~~
@@ -41,15 +43,18 @@ Lmfit requires the following Python packages, with versions given:
4143
All of these are readily available on PyPI, and should be installed
4244
automatically if installing with ``pip install lmfit``.
4345

44-
In order to run the test suite, the `pytest`_ and `flaky`_ packages are required. Some
45-
functionality requires the `emcee`_ (version 3+), `corner`_, `pandas`_, `Jupyter`_,
46-
`matplotlib`_, `dill`_, or `numdifftools`_ packages. These are not installed
47-
automatically, but we highly recommend each of these packages.
48-
49-
For building the documentation and generating the examples gallery,
50-
`matplotlib`_, `emcee`_ (version 3+), `corner`_, `Sphinx`_, `sphinx-gallery`_,
51-
`jupyter_sphinx`_, `Pillow`_, `sphinxcontrib-svg2pdfconverter`_, and `cairosvg`_
52-
are required (the latter two only when generating the PDF document).
46+
In order to run the test suite, the `pytest`_, `pytest-cov`_, and `flaky`_
47+
packages are required. Some functionality requires the `emcee`_ (version 3+),
48+
`corner`_, `pandas`_, `Jupyter`_, `matplotlib`_, `dill`_, or `numdifftools`_
49+
packages. These are not installed automatically, but we highly recommend each
50+
of them.
51+
52+
For building the documentation and generating the examples gallery, `matplotlib`_,
53+
`emcee`_ (version 3+), `corner`_, `Sphinx`_, `sphinx-gallery`_, `jupyter_sphinx`_,
54+
`Pillow`_, and `SymPy`_ are required. For generating the PDF documentation, the Python
55+
packages `sphinxcontrib-svg2pdfconverter`_ and `cairosvg`_ are also required,
56+
as well as the LaTex package `Latexmk`_ (which is included by default in some
57+
LaTex distributions).
5358

5459
Please refer to ``requirements-dev.txt`` for a list of all dependencies that
5560
are needed if you want to participate in the development of lmfit.

‎requirements-dev.txt

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Pillow
1414
pre-commit
1515
pycairo;platform_system=="Windows"
1616
pytest
17+
pytest-cov
1718
Sphinx
1819
sphinx-gallery>=0.10
1920
sphinxcontrib-svg2pdfconverter

0 commit comments

Comments
 (0)
Please sign in to comment.