update docstring

This commit is contained in:
2026-01-22 18:50:07 +01:00
parent d0eabd3252
commit 22cc4f2943
46 changed files with 3647 additions and 1624 deletions

View File

@@ -34,8 +34,9 @@ release = '2019.12.21'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autodoc', # see also autodoc_default_options below
'sphinx.ext.viewcode',
'sphinx.ext.doctest', # see also doctest_global_setup below
]
# Add any paths that contain templates here, relative to this directory.
@@ -92,3 +93,11 @@ html_theme_options = {
autodoc_default_options = {
'special-members': '__iter__, __contains__, __getitem__, __setitem__, __pos__, __neg__, __add__, __iadd__, __sub__, __isub__, __mul__, __rmul__, __imul__, __matmul__, __imatmul__, __abs__, __lt__, __le__, __gt__, __ge__, __eq__, __ne__, __str__, __repr__'
}
doctest_global_setup = '''
from pylib.data import *
from pylib.mathematics import *
from pylib.function import *
from pylib.numerical.integration import *
from pylib.geometry2d import *
'''