Auto api

Signed-off-by: Umberto Zerbinati <[email protected]>
NGSolve · Jun 15, 2024 · 5544253 · 5544253
1 parent a3abd08
commit 5544253
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 11 deletions.
diff --git a/docs/src/api.rst b/docs/src/api.rst
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -20,11 +20,11 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints', 'jupyter_sphinx.execute',"sphinx.ext.mathjax","sphinx.ext.todo",
+extensions = ['sphinx.ext.autodoc', 'sphinx_autodoc_typehints',"sphinx.ext.mathjax","sphinx.ext.todo",
               "IPython.sphinxext.ipython_console_highlighting", "IPython.sphinxext.ipython_directive",
-              "nbsphinx", 'sphinx.ext.autodoc']
+              "nbsphinx", 'sphinx.ext.autodoc', "autoapi.extension"]
 autosummary_generate = True  # Turn on sphinx.ext.autosummary]
-
+autoapi_dirs = ['../../../ngsPETSc']
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 mathjax3_config = {'chtml': {'displayAlign': 'left'}}

diff --git a/docs/src/index.rst b/docs/src/index.rst
@@ -11,7 +11,7 @@ Welcome to ngsPETSc's documentation!
    :caption: Getting Started
 
    install
-   api
+   autoapi/ngsPETSc/index
 
 .. toctree::
    maxdepth: 1

diff --git a/ngsPETSc/pc.py b/ngsPETSc/pc.py
@@ -105,7 +105,9 @@ def createPETScPreconditioner(mat, freeDofs, solverParameters):
 
 
 class ASMPreconditioner(PETScPreconditioner):
-
+    '''
+    This class creates a Netgen/NGSolve BaseMatrix corresponding to a PETSc ASM PC
+    '''
     def __init__(self, mat, freeDofs, solverParameters=None, optionsPrefix="", nullspace=None, matType="aij", blocks=None):
 
         if "sub_pc_type" not in solverParameters: