diff --git a/docs/source/conf.py b/docs/source/conf.py index b0c8cdc..97d3d75 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -23,7 +23,7 @@ author = "J. Varela, G. EspĂ­nola and J. C. Cabral" # The full version, including alpha/beta/rc tags -release = "v0.1.0" +release = "v0.3.0" # -- General configuration --------------------------------------------------- diff --git a/docs/source/function_description.rst b/docs/source/function_description.rst index 3f88b40..e8e17a1 100644 --- a/docs/source/function_description.rst +++ b/docs/source/function_description.rst @@ -1,13 +1,22 @@ Function description ******************** -List of functions in the ``src`` folder. +List of solvers in ``src.solvers`` +---------------------------------- ----- - -.. automodule:: src +.. automodule:: src.solvers .. autofunction:: pd_gmres +.. autofunction:: lgmres +.. autofunction:: gmres_e + +List of utility functions in ``src.utils`` +------------------------------------------ + +.. automodule:: src.utils + +.. autofunction:: augmented_gram_schmidt_arnoldi +.. autofunction:: harmonic_ritz_vectors .. autofunction:: modified_gram_schmidt_arnoldi .. autofunction:: pd_rule .. autofunction:: plane_rotations