Merge pull request #669 from rgommers/docs-cleanup

DOC: update docs for setup.py removal, and fix ReadTheDocs build

.readthedocs.yaml

@@ -0,0 +1,6 @@
+version: 2
+
+python:
+  install:
+    - method: pip
+      path: .

LICENSES_bundled.txt

@@ -6,5 +6,5 @@ Files:  pywt/_pytesttester.py
 License: 3-clause BSD
 
 Name: SciPy
-Files:  setup.py, util/*
+Files:  meson.build, util/*
 License: 3-clause BSD

README.rst

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

codecov.yml

@@ -2,5 +2,5 @@ ignore:
   - "_doc_utils.py"  # utilities only used for creating documentation figures
   - "_pytest*.py"    # pytest test utilities
   - "create_dat.py"  # raw data creation script
-  - "version.py"     # generated by setup.py
+  - "version.py"     # generated by util/version_utils.py
 

doc/release/1.5.0-notes.rst

@@ -4,7 +4,13 @@ PyWavelets 1.5.0 Release Notes
 
 .. contents::
 
-We are very pleased to announce the release of PyWavelets 1.5. 
+We are very pleased to announce the release of PyWavelets 1.5.
+
+PyWavelets now uses Meson as its build system, and meson-python
+as the build backend. This requires no changes from users, a
+``pip install pywavelets`` will now use ``meson-python`` under
+the hood.
+
 
 Authors
 =======

doc/source/dev/building_extension.rst

@@ -14,12 +14,11 @@ repository or use the upstream repository to get the source code::
 Activate your Python virtual environment, go to the cloned source directory
 and type the following commands to build and install the package::
 
-    python setup.py build
-    python setup.py install
+    pip install .
 
 To verify the installation run the following command::
 
-    python setup.py test
+    pytest .
 
 To build docs::
 

doc/source/dev/how_to_release.rst

@@ -25,7 +25,7 @@ The lists of issues closed and PRs merged can be generated via
 Tag the release
 ---------------
 
-Change ``ISRELEASED`` to ``True`` in ``setup.py`` and commit.
+Change ``ISRELEASED`` to ``True`` in ``util/version_utils.py`` and commit.
 
 Tag the release via::
 
@@ -62,9 +62,9 @@ Then run without ``-n``::
 
     git clean -xfd
 
-Create the source distribution files via::
+Create the source distribution file via::
 
-    python setup.py sdist --formats=gztar,zip
+    python -m build --sdist
 
 
 Upload the release to PyPI
@@ -114,7 +114,8 @@ Send release announcements to:
 Prepare for continued development
 ---------------------------------
 
-Increment the version number in setup.py and change ISRELEASED to False.
+Increment the version number in ``util/version_utils.py`` and change
+``ISRELEASED`` to False.
 
 Prepare new release note files for the upcoming release::
 

doc/source/install.rst

@@ -31,16 +31,13 @@ The latest release, is available for download from `PyPI`_ or on the
 `Releases Page`_.
 
 If you want or need to install from source, you will need a working C compiler
-(any common one will work) and a recent version of `Cython`_.  Navigate to the
-PyWavelets source code directory (containing ``setup.py``) and type::
+(any common one will work) installed on your system.  Navigate to the
+PyWavelets source code directory (containing ``pyproject.toml.py``) and type::
 
     pip install .
 
-The requirements needed to build from source are:
-
- - Python_ 2.7 or >=3.4
- - NumPy_ >= 1.13.3
- - Cython_ >= 0.23.5  (if installing from git, not from a PyPI source release)
+For the requirements needed to build from source are (Python, NumPy and Cython
+minimum versions in particular), see ``pyproject.toml``.
 
 To run all the tests for PyWavelets, you will also need to install the
 Matplotlib_ package. If SciPy_ is available, FFT-based continuous wavelet

tox.ini

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

util/readthedocs/requirements.txt

@@ -1,7 +1,7 @@
 numpy
+meson-python
 cython
 pytest
-wheel
 numpydoc
 matplotlib
 docutils<0.18