Merge pull request #29 from v0lta/0.1-release-candidate

v0lta · web-flow · commit 0857445c4076 · 2022-02-24T10:49:10.000+01:00
docs update.
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,16 +3,19 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to PyTorch-Wavelet-Toolbox's documentation!
-===================================================
+
+
+.. include:: ../README.rst
+
+
+Use the ptwt package link below to jump to the documentation of all functions.
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   readme_link
    modules
-   
+
 
 Indices and tables
 ==================
diff --git a/docs/ptwt.rst b/docs/ptwt.rst
@@ -1,9 +1,6 @@
 ptwt package
 ============
 
-Submodules
-----------
-
 ptwt.conv\_transform module
 ---------------------------
 
@@ -20,10 +17,10 @@ ptwt.matmul\_transform module
    :undoc-members:
    :show-inheritance:
 
-ptwt.matmul\_transform\_2d module
+ptwt.matmul\_transform\_2 module
 ---------------------------------
 
-.. automodule:: ptwt.matmul_transform_2d
+.. automodule:: ptwt.matmul_transform_2
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/readme_link.rst b/docs/readme_link.rst
