Skip to content

Commit 95439cf

Browse files
committed
DOC: update all mentions of setup.py in the docs
1 parent fcc32bd commit 95439cf

File tree

9 files changed

+23
-20
lines changed

9 files changed

+23
-20
lines changed

LICENSES_bundled.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ Files: pywt/_pytesttester.py
66
License: 3-clause BSD
77

88
Name: SciPy
9-
Files: setup.py, util/*
9+
Files: meson.build, util/*
1010
License: 3-clause BSD

README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ package name.
9090

9191
If you want or need to install from source, you will need a working C compiler
9292
(any common one will work) and a recent version of `Cython`_. Navigate to the
93-
PyWavelets source code directory (containing ``setup.py``) and type::
93+
PyWavelets source code directory (containing ``pyproject.toml``) and type::
9494

9595
pip install .
9696

codecov.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ ignore:
22
- "_doc_utils.py" # utilities only used for creating documentation figures
33
- "_pytest*.py" # pytest test utilities
44
- "create_dat.py" # raw data creation script
5-
- "version.py" # generated by setup.py
5+
- "version.py" # generated by util/version_utils.py
66

doc/release/1.5.0-notes.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,13 @@ PyWavelets 1.5.0 Release Notes
44

55
.. contents::
66

7-
We are very pleased to announce the release of PyWavelets 1.5.
7+
We are very pleased to announce the release of PyWavelets 1.5.
8+
9+
PyWavelets now uses Meson as its build system, and meson-python
10+
as the build backend. This requires no changes from users, a
11+
``pip install pywavelets`` will now use ``meson-python`` under
12+
the hood.
13+
814

915
Authors
1016
=======

doc/source/dev/building_extension.rst

+2-3
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,11 @@ repository or use the upstream repository to get the source code::
1414
Activate your Python virtual environment, go to the cloned source directory
1515
and type the following commands to build and install the package::
1616

17-
python setup.py build
18-
python setup.py install
17+
pip install .
1918

2019
To verify the installation run the following command::
2120

22-
python setup.py test
21+
pytest .
2322

2423
To build docs::
2524

doc/source/dev/how_to_release.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The lists of issues closed and PRs merged can be generated via
2525
Tag the release
2626
---------------
2727

28-
Change ``ISRELEASED`` to ``True`` in ``setup.py`` and commit.
28+
Change ``ISRELEASED`` to ``True`` in ``util/version_utils.py`` and commit.
2929

3030
Tag the release via::
3131

@@ -62,9 +62,9 @@ Then run without ``-n``::
6262

6363
git clean -xfd
6464

65-
Create the source distribution files via::
65+
Create the source distribution file via::
6666

67-
python setup.py sdist --formats=gztar,zip
67+
python -m build --sdist
6868

6969

7070
Upload the release to PyPI
@@ -114,7 +114,8 @@ Send release announcements to:
114114
Prepare for continued development
115115
---------------------------------
116116

117-
Increment the version number in setup.py and change ISRELEASED to False.
117+
Increment the version number in ``util/version_utils.py`` and change
118+
``ISRELEASED`` to False.
118119

119120
Prepare new release note files for the upcoming release::
120121

doc/source/install.rst

+4-7
Original file line numberDiff line numberDiff line change
@@ -31,16 +31,13 @@ The latest release, is available for download from `PyPI`_ or on the
3131
`Releases Page`_.
3232

3333
If you want or need to install from source, you will need a working C compiler
34-
(any common one will work) and a recent version of `Cython`_. Navigate to the
35-
PyWavelets source code directory (containing ``setup.py``) and type::
34+
(any common one will work) installed on your system. Navigate to the
35+
PyWavelets source code directory (containing ``pyproject.toml.py``) and type::
3636

3737
pip install .
3838

39-
The requirements needed to build from source are:
40-
41-
- Python_ 2.7 or >=3.4
42-
- NumPy_ >= 1.13.3
43-
- Cython_ >= 0.23.5 (if installing from git, not from a PyPI source release)
39+
For the requirements needed to build from source are (Python, NumPy and Cython
40+
minimum versions in particular), see ``pyproject.toml``.
4441

4542
To run all the tests for PyWavelets, you will also need to install the
4643
Matplotlib_ package. If SciPy_ is available, FFT-based continuous wavelet

tox.ini

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
# Running the command 'tox' while in the root of the pywt source
77
# directory will:
8-
# - Create a pywt source distribution (setup.py sdist)
8+
# - Create a pywt source distribution
99
# - Then for every supported version of Python:
1010
# - Create a virtualenv in {homedir}/.tox/pywt/py$VERSION and
1111
# install dependencies. (These virtualenvs are cached across

util/readthedocs/requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
numpy
2+
meson-python
23
cython
34
pytest
4-
wheel
55
numpydoc
66
matplotlib
77
docutils<0.18

0 commit comments

Comments
 (0)