diff --git a/doc/source/reference/kwant.linalg.lapack.rst b/doc/source/reference/kwant.linalg.lapack.rst deleted file mode 100644 index 6a1e026250481df20c4434c061050cd113f86c6b..0000000000000000000000000000000000000000 --- a/doc/source/reference/kwant.linalg.lapack.rst +++ /dev/null @@ -1,6 +0,0 @@ -:mod:`kwant.linalg.lapack` -- Low-level access to LAPACK functions -================================================================== - -.. automodule:: kwant.linalg.lapack - :members: - :undoc-members: diff --git a/doc/source/reference/kwant.linalg.rst b/doc/source/reference/kwant.linalg.rst index cecf2bb46b5b3b654cfbf1c9e65f1631b638fd8f..d535789b664b2c889d69cd50dfe5f8740c084a4a 100644 --- a/doc/source/reference/kwant.linalg.rst +++ b/doc/source/reference/kwant.linalg.rst @@ -3,41 +3,10 @@ .. module:: kwant.linalg -LU decomposition ----------------- -.. autosummary:: - :toctree: generated/ +This package wraps some selected LAPACK functionality not available via NumPy +and also contains a Python-wrapper for MUMPS. It is meant for internal use by +kwant itself, but of course nothing prevents you from using it directly. - lu_factor - lu_solve - rcond_from_lu - -Schur decomposition -------------------- -.. autosummary:: - :toctree: generated/ - - convert_r2c_gen_schur - convert_r2c_schur - evecs_from_gen_schur - evecs_from_schur - gen_schur - order_gen_schur - order_schur - schur - -Eigendecomposition ------------------- -.. autosummary:: - :toctree: generated/ - - gen_eig - - -Submodules ----------- -.. toctree:: - :maxdepth: 1 - - - kwant.linalg.lapack +The documentation of this package is not included here on purpose in order not +to add too many things to this reference. Please consult the source code +directly.