Skip to content

Commit 92d2cf5

Browse files
committed
Replace Fedora build instructions with generic ones
Remove the Fedora build instructions. Nobody in the team currently uses Fedora and can check the instructions. Provide generic instructions based on pip instead.
1 parent f84b97d commit 92d2cf5

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

CONTRIBUTING.rst

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ to build the SciPy lecture notes, can be inferred from the
4646
.. literalinclude:: requirements.txt
4747
:start-after: # libraries before the special comment marked
4848

49+
The installation instructions below cover (i) Debian/Ubuntu with miniconda as this is the
50+
method we use to test and build the material and (ii) generic instructions using pip.
51+
4952
.. topic:: **Building on Debian/Ubuntu**
5053

5154
The environment needed to create an html version of the SciPy lecture notes
@@ -94,13 +97,19 @@ to build the SciPy lecture notes, can be inferred from the
9497
SciPy as explained above. Generating a pdf version requires the system packages
9598
``texlive``, ``texlive-latex-extra``, ``texlive-fonts-extra``, and ``latexmk``.
9699

97-
.. topic:: **Building on Fedora**
100+
.. topic:: **Installing the Python packages with pip**
101+
102+
`pip <https://pip.pypa.io/>`_ is the recommended tool to install Python
103+
packages. However, a number of packages must be installed from the system. Install
104+
Python, the Python "headers" (the `python3-dev` package on Debian, for instance), a C
105+
development environment, `GNU Make <https://www.gnu.org/software/make/>`_, a full LaTeX
106+
distribution (e.g. `TeX Live <https://www.tug.org/texlive/>`_ with extra fonts and
107+
utilities) and `git <https://git-scm.com/>`_.
108+
109+
The remaining software can be installed with `pip`. Depending on the configuration, the
110+
probably most convenient and safe way to proceed is with::
98111

99-
As root::
112+
pip install --user -r requirements.txt
100113

101-
yum install python make python-matplotlib texlive-pdfjam texlive scipy \
102-
texlive-framed texlive-threeparttable texlive-wrapfig texlive-multirow
103-
pip install Sphinx
104-
pip install Cython
105-
pip install scikit-learn
106-
pip install scikit-image
114+
This will install the software in a local directory belonging to the user and will not
115+
interfere with system-wide Python packages.

0 commit comments

Comments
 (0)