Skip to content

Commit

Permalink
MAINT: fix doc build issues (#611)
Browse files Browse the repository at this point in the history
After the multi-resolution and n-D wavelet packets PRs
were merged, the doc build on RTD broke again (we have no CI
for doc build). This PR fixes all issues and warnings.

[ci skip]
  • Loading branch information
rgommers committed Nov 8, 2021
1 parent 3f648f4 commit 70bc050
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 16 deletions.
8 changes: 4 additions & 4 deletions doc/source/ref/mra.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _ref-swt:
.. _ref-mra:

.. currentmodule:: pywt

Expand Down Expand Up @@ -27,17 +27,17 @@ Multilevel n-dimensional ``mran``
.. autofunction:: mran

Inverse Multilevel 1D ``imra``
~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: imra

Inverse Multilevel 2D ``imra2``
~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: imra2

Inverse Multilevel n-dimensional ``imran``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: imran

6 changes: 0 additions & 6 deletions doc/source/ref/wavelet-packets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ BaseNode - a common interface of WaveletPacket and WaveletPacket2D
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. class:: BaseNode
Node(BaseNode)
WaveletPacket(Node)
Node2D(BaseNode)
WaveletPacket2D(Node2D)

.. note:: The BaseNode is a base class for :class:`Node` and :class:`Node2D`.
It should not be used directly unless creating a new transformation
Expand Down Expand Up @@ -222,7 +218,6 @@ WaveletPacket and WaveletPacket tree Node
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. class:: Node(BaseNode)
WaveletPacket(Node)

.. attribute:: node_name

Expand Down Expand Up @@ -276,7 +271,6 @@ WaveletPacket2D and WaveletPacket2D tree Node2D
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. class:: Node2D(BaseNode)
WaveletPacket2D(Node2D)

.. attribute:: node_name

Expand Down
12 changes: 6 additions & 6 deletions pywt/_mra.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ def mra(data, wavelet, level=None, axis=-1, transform='swt',
See Also
--------
``imra``, ``swt``
imra, swt
Notes
-----
Expand Down Expand Up @@ -128,7 +128,7 @@ def imra(mra_coeffs):
See Also
--------
``mra``
mra
References
----------
Expand Down Expand Up @@ -186,7 +186,7 @@ def mra2(data, wavelet, level=None, axes=(-2, -1), transform='swt2',
See Also
--------
``imra2``, ``swt2``
imra2, swt2
References
----------
Expand Down Expand Up @@ -264,7 +264,7 @@ def imra2(mra_coeffs):
See Also
--------
``mra2``
mra2
References
----------
Expand Down Expand Up @@ -311,7 +311,7 @@ def mran(data, wavelet, level=None, axes=None, transform='swtn',
See Also
--------
``imran``, ``swtn``
imran, swtn
Notes
-----
Expand Down Expand Up @@ -411,7 +411,7 @@ def imran(mra_coeffs):
See Also
--------
``mran``
mran
References
----------
Expand Down

0 comments on commit 70bc050

Please sign in to comment.