Commit 43adef4c authored by Henri Payno's avatar Henri Payno
Browse files

[doc] add API documentation

parent ef8f551d
......@@ -44,7 +44,7 @@ templates_path = ['templates']
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
source_suffix = ['.rst', '.md']
source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
#source_parsers = {".md": "recommonmark.parser.CommonMarkParser"}
# The encoding of source files.
#source_encoding = 'utf-8-sig'
......
......@@ -18,7 +18,7 @@ An `Orange3 <https://github.com/biolab/orange3>`_ add-on is also provided by the
tutorials/index.rst
install.rst
api.rst
modules/index.rst
larch_pymca.rst
app/index.rst
......@@ -29,6 +29,9 @@ An `Orange3 <https://github.com/biolab/orange3>`_ add-on is also provided by the
:doc:`app/index`
Applications
:doc:`modules/index`
API
:doc:`tutorials/index`
tutorials for using the xas library
......
......@@ -89,9 +89,6 @@ You also should generate documentation to be accessible from Orange GUI (pressin
To get more information about help from Orange see :
:doc:`other/help`
accessing documentation from the interface
Warning
:::::::
......
xas.core package
================
Subpackages
-----------
.. toctree::
utils/index.rst
process/index.rst
xas.core.io module
------------------
.. automodule:: xas.core.io
:members:
:undoc-members:
:show-inheritance:
xas.core.reprocessing module
----------------------------
.. automodule:: xas.core.reprocessing
:members:
:undoc-members:
:show-inheritance:
xas.core.types module
---------------------
.. automodule:: xas.core.types
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.core
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
utils/index.rst
xas.core.process package
========================
Subpackages
-----------
.. toctree::
xas.core.process.larch
xas.core.process.pymca
xas.core.process.process module
-------------------------------
.. automodule:: xas.core.process.process
:members:
:undoc-members:
:show-inheritance:
xas.core.process.progress module
--------------------------------
.. automodule:: xas.core.process.progress
:members:
:undoc-members:
:show-inheritance:
xas.core.process.roi module
---------------------------
.. automodule:: xas.core.process.roi
:members:
:undoc-members:
:show-inheritance:
xas.core.process.setup module
-----------------------------
.. automodule:: xas.core.process.setup
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.core.process
:members:
:undoc-members:
:show-inheritance:
xas.core.process.larch package
==============================
xas.core.process.larch.autobk module
------------------------------------
.. automodule:: xas.core.process.larch.autobk
:members:
:undoc-members:
:show-inheritance:
xas.core.process.larch.mback module
-----------------------------------
.. automodule:: xas.core.process.larch.mback
:members:
:undoc-members:
:show-inheritance:
xas.core.process.larch.mback\_norm module
-----------------------------------------
.. automodule:: xas.core.process.larch.mback_norm
:members:
:undoc-members:
:show-inheritance:
xas.core.process.larch.pre\_edge module
---------------------------------------
.. automodule:: xas.core.process.larch.pre_edge
:members:
:undoc-members:
:show-inheritance:
xas.core.process.larch.xftf module
----------------------------------
.. automodule:: xas.core.process.larch.xftf
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.core.process.larch
:members:
:undoc-members:
:show-inheritance:
xas.core.process.pymca package
==============================
xas.core.process.pymca.exafs module
-----------------------------------
.. automodule:: xas.core.process.pymca.exafs
:members:
:undoc-members:
:show-inheritance:
xas.core.process.pymca.ft module
--------------------------------
.. automodule:: xas.core.process.pymca.ft
:members:
:undoc-members:
:show-inheritance:
xas.core.process.pymca.k\_weight module
---------------------------------------
.. automodule:: xas.core.process.pymca.k_weight
:members:
:undoc-members:
:show-inheritance:
xas.core.process.pymca.normalization module
-------------------------------------------
.. automodule:: xas.core.process.pymca.normalization
:members:
:undoc-members:
:show-inheritance:
xas.core.process.pymca.setup module
-----------------------------------
.. automodule:: xas.core.process.pymca.setup
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.core.process.pymca
:members:
:undoc-members:
:show-inheritance:
xas.core.utils package
======================
xas.core.utils.designpattern module
-----------------------------------
.. automodule:: xas.core.utils.designpattern
:members:
:undoc-members:
:show-inheritance:
xas.core.utils.spectra module
-----------------------------
.. automodule:: xas.core.utils.spectra
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.core.utils
:members:
:undoc-members:
:show-inheritance:
xas.gui package
===============
Subpackages
-----------
xas.gui.XasObjectViewer module
------------------------------
.. automodule:: xas.gui.XasObjectViewer
:members:
:undoc-members:
:show-inheritance:
xas.gui.icons module
--------------------
.. automodule:: xas.gui.icons
:members:
:undoc-members:
:show-inheritance:
xas.gui.qtapplicationmanager module
-----------------------------------
.. automodule:: xas.gui.qtapplicationmanager
:members:
:undoc-members:
:show-inheritance:
xas.gui.roiselector module
--------------------------
.. automodule:: xas.gui.roiselector
:members:
:undoc-members:
:show-inheritance:
xas.gui.xas\_object\_definition module
--------------------------------------
.. automodule:: xas.gui.xas_object_definition
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.gui
:members:
:undoc-members:
:show-inheritance:
.. toctree::
:maxdepth: 4
larch/xas.gui.larch.rst
xas.gui.larch package
=====================
xas.gui.larch.autobk module
---------------------------
.. automodule:: xas.gui.larch.autobk
:members:
:undoc-members:
:show-inheritance:
xas.gui.larch.mback module
--------------------------
.. automodule:: xas.gui.larch.mback
:members:
:undoc-members:
:show-inheritance:
xas.gui.larch.pre\_edge module
------------------------------
.. automodule:: xas.gui.larch.pre_edge
:members:
:undoc-members:
:show-inheritance:
xas.gui.larch.utils module
--------------------------
.. automodule:: xas.gui.larch.utils
:members:
:undoc-members:
:show-inheritance:
xas.gui.larch.xftf module
-------------------------
.. automodule:: xas.gui.larch.xftf
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.gui.larch
:members:
:undoc-members:
:show-inheritance:
API
===
.. toctree::
:maxdepth: 4
core/index.rst
gui/index.rst
io/index.rst
pushworkflow/index.rst
xas.io package
==============
Subpackages
-----------
.. toctree::
xas.io.utils
xas.io.io module
----------------
.. automodule:: xas.io.io
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.io
:members:
:undoc-members:
:show-inheritance:
xas.io.utils package
====================
xas.io.utils.larch module
-------------------------
.. automodule:: xas.io.utils.larch
:members:
:undoc-members:
:show-inheritance:
xas.io.utils.pymca module
-------------------------
.. automodule:: xas.io.utils.pymca
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: xas.io.utils
:members:
:undoc-members:
:show-inheritance:
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