Commit 400e7a09 authored by Henri Payno's avatar Henri Payno
Browse files

[doc] move to autosumary and improve doc

parent 335339a0
Pipeline #55865 failed with stages
in 4 minutes and 48 seconds
......@@ -22,7 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to the larch mback process"""
"""wrapper to the larch mback-norm process"""
from est.core.types import Spectrum, XASObject
from est.core.process.process import Process
......
......@@ -22,7 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to the larch mback process"""
"""wrapper to the larch pre-edge process"""
from est.core.types import Spectrum, XASObject
from est.core.process.process import Process
......
# coding: utf-8
# /*##########################################################################
# Copyright (C) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ############################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "07/25/2019"
......@@ -22,7 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to the larch mback process"""
"""wrapper to the larch xftf process"""
from est.core.types import Spectrum, XASObject
from est.core.process.process import Process
......
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to pymca `exafs` process"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to pymca `ft` process"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to pymca `k-weight` process"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""wrapper to pymca `normalization` process"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
# coding: utf-8
# /*##########################################################################
# Copyright (C) 2016-2017 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ############################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "07/21/2021"
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2016-2018 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "06/12/2019"
import logging
_logger = logging.getLogger(__name__)
"""
est.core.types module: contains main core level est types
"""
from .spectrum import Spectrum # noqa
from .spectra import Spectra # noqa
from .sample import Sample # noqa
......
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################
"""container for est.core utils functions"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
"""est graphical user interface module"""
"""est input / output module"""
from .io import * # noqa
......@@ -22,6 +22,7 @@
# THE SOFTWARE.
#
# ###########################################################################*/
"""est settings"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
......
# coding: utf-8
# /*##########################################################################
#
# Copyright (c) 2015-2019 European Synchrotron Radiation Facility
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
# ###########################################################################*/
"""This package provides access to the full silx test suite.
It is possible to disable tests depending on Qt by setting
`silx.test.utils.test_options.WITH_QT_TEST = False`
It will skip all tests from :mod:`silx.test.gui`.
"""
__authors__ = ["H. Payno"]
__license__ = "MIT"
__date__ = "06/12/2019"
import logging
logger = logging.getLogger(__name__)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment