From fac9eead34817d53a02aa25e4cfc9a5e2f127386 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Tue, 28 Aug 2018 18:42:27 +0200 Subject: [PATCH 01/13] Fix #1972 --- doc/api/hyperspy._components.rst | 198 ---------------- doc/api/hyperspy._signals.rst | 126 ---------- doc/api/hyperspy.datasets.rst | 31 --- doc/api/hyperspy.docstrings.rst | 38 --- doc/api/hyperspy.drawing._markers.rst | 78 ------- doc/api/hyperspy.drawing._widgets.rst | 78 ------- doc/api/hyperspy.drawing.rst | 118 ---------- doc/api/hyperspy.external.astroML.rst | 30 --- doc/api/hyperspy.external.mpfit.rst | 38 --- doc/api/hyperspy.external.rst | 30 --- doc/api/hyperspy.io_plugins.rst | 158 ------------- doc/api/hyperspy.learn.rst | 54 ----- doc/api/hyperspy.misc.eds.rst | 30 --- doc/api/hyperspy.misc.eels.rst | 62 ----- doc/api/hyperspy.misc.holography.rst | 22 -- doc/api/hyperspy.misc.io.rst | 30 --- doc/api/hyperspy.misc.machine_learning.rst | 38 --- doc/api/hyperspy.misc.rst | 161 ------------- doc/api/hyperspy.models.rst | 62 ----- doc/api/hyperspy.rst | 217 ------------------ ...py.samfire_utils.goodness_of_fit_tests.rst | 38 --- doc/api/hyperspy.samfire_utils.rst | 79 ------- doc/api/hyperspy.samfire_utils.segmenters.rst | 22 -- doc/api/hyperspy.samfire_utils.weights.rst | 22 -- doc/api/hyperspy.tests.axes.rst | 30 --- doc/api/hyperspy.tests.component.rst | 38 --- doc/api/hyperspy.tests.datasets.rst | 22 -- doc/api/hyperspy.tests.drawing.rst | 94 -------- doc/api/hyperspy.tests.io.rst | 142 ------------ doc/api/hyperspy.tests.misc.rst | 70 ------ doc/api/hyperspy.tests.model.rst | 134 ----------- doc/api/hyperspy.tests.mva.rst | 54 ----- doc/api/hyperspy.tests.rst | 55 ----- doc/api/hyperspy.tests.samfire.rst | 70 ------ doc/api/hyperspy.tests.signal.rst | 206 ----------------- doc/api/hyperspy.tests.utils.rst | 62 ----- doc/api/hyperspy.utils.rst | 86 ------- doc/api/modules.rst | 7 - doc/conf.py | 11 + doc/generate_api_doc.sh | 4 - doc/gh-pages.py | 1 - 41 files changed, 11 insertions(+), 2835 deletions(-) delete mode 100644 doc/api/hyperspy._components.rst delete mode 100644 doc/api/hyperspy._signals.rst delete mode 100644 doc/api/hyperspy.datasets.rst delete mode 100644 doc/api/hyperspy.docstrings.rst delete mode 100644 doc/api/hyperspy.drawing._markers.rst delete mode 100644 doc/api/hyperspy.drawing._widgets.rst delete mode 100644 doc/api/hyperspy.drawing.rst delete mode 100644 doc/api/hyperspy.external.astroML.rst delete mode 100644 doc/api/hyperspy.external.mpfit.rst delete mode 100644 doc/api/hyperspy.external.rst delete mode 100644 doc/api/hyperspy.io_plugins.rst delete mode 100644 doc/api/hyperspy.learn.rst delete mode 100644 doc/api/hyperspy.misc.eds.rst delete mode 100644 doc/api/hyperspy.misc.eels.rst delete mode 100644 doc/api/hyperspy.misc.holography.rst delete mode 100644 doc/api/hyperspy.misc.io.rst delete mode 100644 doc/api/hyperspy.misc.machine_learning.rst delete mode 100644 doc/api/hyperspy.misc.rst delete mode 100644 doc/api/hyperspy.models.rst delete mode 100644 doc/api/hyperspy.rst delete mode 100644 doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst delete mode 100644 doc/api/hyperspy.samfire_utils.rst delete mode 100644 doc/api/hyperspy.samfire_utils.segmenters.rst delete mode 100644 doc/api/hyperspy.samfire_utils.weights.rst delete mode 100644 doc/api/hyperspy.tests.axes.rst delete mode 100644 doc/api/hyperspy.tests.component.rst delete mode 100644 doc/api/hyperspy.tests.datasets.rst delete mode 100644 doc/api/hyperspy.tests.drawing.rst delete mode 100644 doc/api/hyperspy.tests.io.rst delete mode 100644 doc/api/hyperspy.tests.misc.rst delete mode 100644 doc/api/hyperspy.tests.model.rst delete mode 100644 doc/api/hyperspy.tests.mva.rst delete mode 100644 doc/api/hyperspy.tests.rst delete mode 100644 doc/api/hyperspy.tests.samfire.rst delete mode 100644 doc/api/hyperspy.tests.signal.rst delete mode 100644 doc/api/hyperspy.tests.utils.rst delete mode 100644 doc/api/hyperspy.utils.rst delete mode 100644 doc/api/modules.rst delete mode 100755 doc/generate_api_doc.sh diff --git a/doc/api/hyperspy._components.rst b/doc/api/hyperspy._components.rst deleted file mode 100644 index e9d3b91f04..0000000000 --- a/doc/api/hyperspy._components.rst +++ /dev/null @@ -1,198 +0,0 @@ -hyperspy.\_components package -============================= - -Submodules ----------- - -hyperspy.\_components.arctan module ------------------------------------ - -.. automodule:: hyperspy._components.arctan - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.bleasdale module --------------------------------------- - -.. automodule:: hyperspy._components.bleasdale - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.eels\_cl\_edge module -------------------------------------------- - -.. automodule:: hyperspy._components.eels_cl_edge - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.eels\_double\_power\_law module ------------------------------------------------------ - -.. automodule:: hyperspy._components.eels_double_power_law - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.eels\_vignetting module ---------------------------------------------- - -.. automodule:: hyperspy._components.eels_vignetting - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.error\_function module --------------------------------------------- - -.. automodule:: hyperspy._components.error_function - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.exponential module ----------------------------------------- - -.. automodule:: hyperspy._components.exponential - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.expression module ---------------------------------------- - -.. automodule:: hyperspy._components.expression - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.gaussian module -------------------------------------- - -.. automodule:: hyperspy._components.gaussian - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.gaussian2d module ---------------------------------------- - -.. automodule:: hyperspy._components.gaussian2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.gaussianhf module ---------------------------------------- - -.. automodule:: hyperspy._components.gaussianhf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.heaviside module --------------------------------------- - -.. automodule:: hyperspy._components.heaviside - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.logistic module -------------------------------------- - -.. automodule:: hyperspy._components.logistic - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.lorentzian module ---------------------------------------- - -.. automodule:: hyperspy._components.lorentzian - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.offset module ------------------------------------ - -.. automodule:: hyperspy._components.offset - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.pes\_core\_line\_shape module ---------------------------------------------------- - -.. automodule:: hyperspy._components.pes_core_line_shape - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.pes\_see module -------------------------------------- - -.. automodule:: hyperspy._components.pes_see - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.polynomial module ---------------------------------------- - -.. automodule:: hyperspy._components.polynomial - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.power\_law module ---------------------------------------- - -.. automodule:: hyperspy._components.power_law - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.rc module -------------------------------- - -.. automodule:: hyperspy._components.rc - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.scalable\_fixed\_pattern module ------------------------------------------------------ - -.. automodule:: hyperspy._components.scalable_fixed_pattern - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.voigt module ----------------------------------- - -.. automodule:: hyperspy._components.voigt - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_components.volume\_plasmon\_drude module ---------------------------------------------------- - -.. automodule:: hyperspy._components.volume_plasmon_drude - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy._components - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy._signals.rst b/doc/api/hyperspy._signals.rst deleted file mode 100644 index fe1aca32b2..0000000000 --- a/doc/api/hyperspy._signals.rst +++ /dev/null @@ -1,126 +0,0 @@ -hyperspy.\_signals package -========================== - -Submodules ----------- - -hyperspy.\_signals.common\_signal1d module ------------------------------------------- - -.. automodule:: hyperspy._signals.common_signal1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.common\_signal2d module ------------------------------------------- - -.. automodule:: hyperspy._signals.common_signal2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.complex\_signal module ------------------------------------------ - -.. automodule:: hyperspy._signals.complex_signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.complex\_signal1d module -------------------------------------------- - -.. automodule:: hyperspy._signals.complex_signal1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.complex\_signal2d module -------------------------------------------- - -.. automodule:: hyperspy._signals.complex_signal2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.dielectric\_function module ----------------------------------------------- - -.. automodule:: hyperspy._signals.dielectric_function - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.eds module ------------------------------ - -.. automodule:: hyperspy._signals.eds - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.eds\_sem module ----------------------------------- - -.. automodule:: hyperspy._signals.eds_sem - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.eds\_tem module ----------------------------------- - -.. automodule:: hyperspy._signals.eds_tem - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.eels module ------------------------------- - -.. automodule:: hyperspy._signals.eels - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.hologram\_image module ------------------------------------------ - -.. automodule:: hyperspy._signals.hologram_image - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.lazy module ------------------------------- - -.. automodule:: hyperspy._signals.lazy - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.signal1d module ----------------------------------- - -.. automodule:: hyperspy._signals.signal1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_signals.signal2d module ----------------------------------- - -.. automodule:: hyperspy._signals.signal2d - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy._signals - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.datasets.rst b/doc/api/hyperspy.datasets.rst deleted file mode 100644 index 65d04b35b9..0000000000 --- a/doc/api/hyperspy.datasets.rst +++ /dev/null @@ -1,31 +0,0 @@ -hyperspy.datasets package -========================= - -Submodules ----------- - -hyperspy.datasets.example\_signals module ------------------------------------------ - -.. automodule:: hyperspy.datasets.example_signals - :members: - :undoc-members: - :show-inheritance: - - -hyperspy\.datasets\.artificial\_data module -------------------------------------------- - -.. automodule:: hyperspy.datasets.artificial_data - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.datasets - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.docstrings.rst b/doc/api/hyperspy.docstrings.rst deleted file mode 100644 index e2d8cf8f3e..0000000000 --- a/doc/api/hyperspy.docstrings.rst +++ /dev/null @@ -1,38 +0,0 @@ -hyperspy.docstrings package -=========================== - -Submodules ----------- - -hyperspy.docstrings.plot module -------------------------------- - -.. automodule:: hyperspy.docstrings.plot - :members: - :undoc-members: - :show-inheritance: - -hyperspy.docstrings.signal module ---------------------------------- - -.. automodule:: hyperspy.docstrings.signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.docstrings.signal1d module ------------------------------------ - -.. automodule:: hyperspy.docstrings.signal1d - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.docstrings - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.drawing._markers.rst b/doc/api/hyperspy.drawing._markers.rst deleted file mode 100644 index 13580c14cf..0000000000 --- a/doc/api/hyperspy.drawing._markers.rst +++ /dev/null @@ -1,78 +0,0 @@ -hyperspy.drawing.\_markers package -================================== - -Submodules ----------- - -hyperspy.drawing.\_markers.horizontal\_line module --------------------------------------------------- - -.. automodule:: hyperspy.drawing._markers.horizontal_line - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.horizontal\_line\_segment module ------------------------------------------------------------ - -.. automodule:: hyperspy.drawing._markers.horizontal_line_segment - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.line\_segment module ------------------------------------------------ - -.. automodule:: hyperspy.drawing._markers.line_segment - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.point module ---------------------------------------- - -.. automodule:: hyperspy.drawing._markers.point - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.rectangle module -------------------------------------------- - -.. automodule:: hyperspy.drawing._markers.rectangle - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.text module --------------------------------------- - -.. automodule:: hyperspy.drawing._markers.text - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.vertical\_line module ------------------------------------------------- - -.. automodule:: hyperspy.drawing._markers.vertical_line - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_markers.vertical\_line\_segment module ---------------------------------------------------------- - -.. automodule:: hyperspy.drawing._markers.vertical_line_segment - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.drawing._markers - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.drawing._widgets.rst b/doc/api/hyperspy.drawing._widgets.rst deleted file mode 100644 index 0856c349bb..0000000000 --- a/doc/api/hyperspy.drawing._widgets.rst +++ /dev/null @@ -1,78 +0,0 @@ -hyperspy.drawing.\_widgets package -================================== - -Submodules ----------- - -hyperspy.drawing.\_widgets.circle module ----------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.circle - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.horizontal\_line module --------------------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.horizontal_line - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.label module ---------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.label - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.line2d module ----------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.line2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.range module ---------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.range - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.rectangles module --------------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.rectangles - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.scalebar module ------------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.scalebar - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.\_widgets.vertical\_line module ------------------------------------------------- - -.. automodule:: hyperspy.drawing._widgets.vertical_line - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.drawing._widgets - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.drawing.rst b/doc/api/hyperspy.drawing.rst deleted file mode 100644 index 1549573f96..0000000000 --- a/doc/api/hyperspy.drawing.rst +++ /dev/null @@ -1,118 +0,0 @@ -hyperspy.drawing package -======================== - -Subpackages ------------ - -.. toctree:: - - hyperspy.drawing._markers - hyperspy.drawing._widgets - -Submodules ----------- - -hyperspy.drawing.figure module ------------------------------- - -.. automodule:: hyperspy.drawing.figure - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.image module ------------------------------ - -.. automodule:: hyperspy.drawing.image - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.marker module ------------------------------- - -.. automodule:: hyperspy.drawing.marker - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.mpl\_he module -------------------------------- - -.. automodule:: hyperspy.drawing.mpl_he - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.mpl\_hie module --------------------------------- - -.. automodule:: hyperspy.drawing.mpl_hie - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.mpl\_hse module --------------------------------- - -.. automodule:: hyperspy.drawing.mpl_hse - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.signal module ------------------------------- - -.. automodule:: hyperspy.drawing.signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.signal1d module --------------------------------- - -.. automodule:: hyperspy.drawing.signal1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.tiles module ------------------------------ - -.. automodule:: hyperspy.drawing.tiles - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.utils module ------------------------------ - -.. automodule:: hyperspy.drawing.utils - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.widget module ------------------------------- - -.. automodule:: hyperspy.drawing.widget - :members: - :undoc-members: - :show-inheritance: - -hyperspy.drawing.widgets module -------------------------------- - -.. automodule:: hyperspy.drawing.widgets - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.drawing - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.external.astroML.rst b/doc/api/hyperspy.external.astroML.rst deleted file mode 100644 index 18bbdc523b..0000000000 --- a/doc/api/hyperspy.external.astroML.rst +++ /dev/null @@ -1,30 +0,0 @@ -hyperspy.external.astroML package -================================= - -Submodules ----------- - -hyperspy.external.astroML.bayesian\_blocks module -------------------------------------------------- - -.. automodule:: hyperspy.external.astroML.bayesian_blocks - :members: - :undoc-members: - :show-inheritance: - -hyperspy.external.astroML.histtools module ------------------------------------------- - -.. automodule:: hyperspy.external.astroML.histtools - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.external.astroML - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.external.mpfit.rst b/doc/api/hyperspy.external.mpfit.rst deleted file mode 100644 index 90c8abcf3d..0000000000 --- a/doc/api/hyperspy.external.mpfit.rst +++ /dev/null @@ -1,38 +0,0 @@ -hyperspy.external.mpfit package -=============================== - -Submodules ----------- - -hyperspy.external.mpfit.mpfit module ------------------------------------- - -.. automodule:: hyperspy.external.mpfit.mpfit - :members: - :undoc-members: - :show-inheritance: - -hyperspy.external.mpfit.mpfitexpr module ----------------------------------------- - -.. automodule:: hyperspy.external.mpfit.mpfitexpr - :members: - :undoc-members: - :show-inheritance: - -hyperspy.external.mpfit.test\_mpfit module ------------------------------------------- - -.. automodule:: hyperspy.external.mpfit.test_mpfit - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.external.mpfit - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.external.rst b/doc/api/hyperspy.external.rst deleted file mode 100644 index 0cd44aea9f..0000000000 --- a/doc/api/hyperspy.external.rst +++ /dev/null @@ -1,30 +0,0 @@ -hyperspy.external package -========================= - -Subpackages ------------ - -.. toctree:: - - hyperspy.external.astroML - hyperspy.external.mpfit - -Submodules ----------- - -hyperspy.external.progressbar module ------------------------------------- - -.. automodule:: hyperspy.external.progressbar - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.external - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.io_plugins.rst b/doc/api/hyperspy.io_plugins.rst deleted file mode 100644 index 93c2f35c7e..0000000000 --- a/doc/api/hyperspy.io_plugins.rst +++ /dev/null @@ -1,158 +0,0 @@ -hyperspy.io\_plugins package -============================ - -Submodules ----------- - -hyperspy.io\_plugins.bcf module -------------------------------- - -.. automodule:: hyperspy.io_plugins.bcf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.blockfile module -------------------------------------- - -.. automodule:: hyperspy.io_plugins.blockfile - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.dens module --------------------------------- - -.. automodule:: hyperspy.io_plugins.dens - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.digital\_micrograph module ------------------------------------------------ - -.. automodule:: hyperspy.io_plugins.digital_micrograph - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.edax module --------------------------------- - -.. automodule:: hyperspy.io_plugins.edax - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.emd module -------------------------------- - -.. automodule:: hyperspy.io_plugins.emd - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.fei module -------------------------------- - -.. automodule:: hyperspy.io_plugins.fei - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.hspy module --------------------------------- - -.. automodule:: hyperspy.io_plugins.hspy - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.image module ---------------------------------- - -.. automodule:: hyperspy.io_plugins.image - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.mrc module -------------------------------- - -.. automodule:: hyperspy.io_plugins.mrc - :members: - :undoc-members: - :show-inheritance: - -hyperspy\.io\_plugins\.mrcz module ---------------------------------- - -.. automodule:: hyperspy.io_plugins.mrcz - :members: - :undoc-members: - :show-inheritance: - -hyperspy\.io\_plugins\.msa module ---------------------------------- - -.. automodule:: hyperspy.io_plugins.msa - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.netcdf module ----------------------------------- - -.. automodule:: hyperspy.io_plugins.netcdf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.protochips module --------------------------------------- - -.. automodule:: hyperspy.io_plugins.protochips - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.ripple module ----------------------------------- - -.. automodule:: hyperspy.io_plugins.ripple - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.semper\_unf module ---------------------------------------- - -.. automodule:: hyperspy.io_plugins.semper_unf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.tiff module --------------------------------- - -.. automodule:: hyperspy.io_plugins.tiff - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io\_plugins.unbcf\_fast module ---------------------------------------- - -.. automodule:: hyperspy.io_plugins.unbcf_fast - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.io_plugins - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.learn.rst b/doc/api/hyperspy.learn.rst deleted file mode 100644 index 41199f7663..0000000000 --- a/doc/api/hyperspy.learn.rst +++ /dev/null @@ -1,54 +0,0 @@ -hyperspy.learn package -====================== - -Submodules ----------- - -hyperspy.learn.mlpca module ---------------------------- - -.. automodule:: hyperspy.learn.mlpca - :members: - :undoc-members: - :show-inheritance: - -hyperspy.learn.mva module -------------------------- - -.. automodule:: hyperspy.learn.mva - :members: - :undoc-members: - :show-inheritance: - -hyperspy.learn.onmf module --------------------------- - -.. automodule:: hyperspy.learn.onmf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.learn.rpca module --------------------------- - -.. automodule:: hyperspy.learn.rpca - :members: - :undoc-members: - :show-inheritance: - -hyperspy.learn.svd\_pca module ------------------------------- - -.. automodule:: hyperspy.learn.svd_pca - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.learn - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.eds.rst b/doc/api/hyperspy.misc.eds.rst deleted file mode 100644 index b4329eb20b..0000000000 --- a/doc/api/hyperspy.misc.eds.rst +++ /dev/null @@ -1,30 +0,0 @@ -hyperspy.misc.eds package -========================= - -Submodules ----------- - -hyperspy.misc.eds.ffast\_mac module ------------------------------------ - -.. automodule:: hyperspy.misc.eds.ffast_mac - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eds.utils module ------------------------------- - -.. automodule:: hyperspy.misc.eds.utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc.eds - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.eels.rst b/doc/api/hyperspy.misc.eels.rst deleted file mode 100644 index ae428b2c3b..0000000000 --- a/doc/api/hyperspy.misc.eels.rst +++ /dev/null @@ -1,62 +0,0 @@ -hyperspy.misc.eels package -========================== - -Submodules ----------- - -hyperspy.misc.eels.base\_gos module ------------------------------------ - -.. automodule:: hyperspy.misc.eels.base_gos - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eels.eelsdb module --------------------------------- - -.. automodule:: hyperspy.misc.eels.eelsdb - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eels.effective\_angle module ------------------------------------------- - -.. automodule:: hyperspy.misc.eels.effective_angle - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eels.hartree\_slater\_gos module ----------------------------------------------- - -.. automodule:: hyperspy.misc.eels.hartree_slater_gos - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eels.hydrogenic\_gos module ------------------------------------------ - -.. automodule:: hyperspy.misc.eels.hydrogenic_gos - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.eels.tools module -------------------------------- - -.. automodule:: hyperspy.misc.eels.tools - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc.eels - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.holography.rst b/doc/api/hyperspy.misc.holography.rst deleted file mode 100644 index 3aaee10114..0000000000 --- a/doc/api/hyperspy.misc.holography.rst +++ /dev/null @@ -1,22 +0,0 @@ -hyperspy.misc.holography package -================================ - -Submodules ----------- - -hyperspy.misc.holography.reconstruct module -------------------------------------------- - -.. automodule:: hyperspy.misc.holography.reconstruct - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc.holography - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.io.rst b/doc/api/hyperspy.misc.io.rst deleted file mode 100644 index 0bd0fc63a7..0000000000 --- a/doc/api/hyperspy.misc.io.rst +++ /dev/null @@ -1,30 +0,0 @@ -hyperspy.misc.io package -======================== - -Submodules ----------- - -hyperspy.misc.io.tools module ------------------------------ - -.. automodule:: hyperspy.misc.io.tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.io.utils\_readfile module ---------------------------------------- - -.. automodule:: hyperspy.misc.io.utils_readfile - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc.io - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.machine_learning.rst b/doc/api/hyperspy.misc.machine_learning.rst deleted file mode 100644 index 7560c72d16..0000000000 --- a/doc/api/hyperspy.misc.machine_learning.rst +++ /dev/null @@ -1,38 +0,0 @@ -hyperspy.misc.machine\_learning package -======================================= - -Submodules ----------- - -hyperspy.misc.machine\_learning.import\_sklearn module ------------------------------------------------------- - -.. automodule:: hyperspy.misc.machine_learning.import_sklearn - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.machine\_learning.orthomax module ------------------------------------------------ - -.. automodule:: hyperspy.misc.machine_learning.orthomax - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.machine\_learning.tools module --------------------------------------------- - -.. automodule:: hyperspy.misc.machine_learning.tools - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc.machine_learning - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.misc.rst b/doc/api/hyperspy.misc.rst deleted file mode 100644 index 495c3a4da3..0000000000 --- a/doc/api/hyperspy.misc.rst +++ /dev/null @@ -1,161 +0,0 @@ -hyperspy.misc package -===================== - -Subpackages ------------ - -.. toctree:: - - hyperspy.misc.eds - hyperspy.misc.eels - hyperspy.misc.holography - hyperspy.misc.io - hyperspy.misc.machine_learning - -Submodules ----------- - -hyperspy.misc.array\_tools module ---------------------------------- - -.. automodule:: hyperspy.misc.array_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.config\_dir module --------------------------------- - -.. automodule:: hyperspy.misc.config_dir - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.date\_time\_tools module --------------------------------------- - -.. automodule:: hyperspy.misc.date_time_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.elements module ------------------------------ - -.. automodule:: hyperspy.misc.elements - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.example\_signals\_loading module ----------------------------------------------- - -.. automodule:: hyperspy.misc.example_signals_loading - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.export\_dictionary module ---------------------------------------- - -.. automodule:: hyperspy.misc.export_dictionary - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.ipython\_tools module ------------------------------------ - -.. automodule:: hyperspy.misc.ipython_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.material module ------------------------------ - -.. automodule:: hyperspy.misc.material - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.math\_tools module --------------------------------- - -.. automodule:: hyperspy.misc.math_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.physical\_constants module ----------------------------------------- - -.. automodule:: hyperspy.misc.physical_constants - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.physics\_tools module ------------------------------------ - -.. automodule:: hyperspy.misc.physics_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.rgb\_tools module -------------------------------- - -.. automodule:: hyperspy.misc.rgb_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.signal\_tools module ----------------------------------- - -.. automodule:: hyperspy.misc.signal_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.slicing module ----------------------------- - -.. automodule:: hyperspy.misc.slicing - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.test\_utils module --------------------------------- - -.. automodule:: hyperspy.misc.test_utils - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.tv\_denoise module --------------------------------- - -.. automodule:: hyperspy.misc.tv_denoise - :members: - :undoc-members: - :show-inheritance: - -hyperspy.misc.utils module --------------------------- - -.. automodule:: hyperspy.misc.utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.misc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.models.rst b/doc/api/hyperspy.models.rst deleted file mode 100644 index 250634da22..0000000000 --- a/doc/api/hyperspy.models.rst +++ /dev/null @@ -1,62 +0,0 @@ -hyperspy.models package -======================= - -Submodules ----------- - -hyperspy.models.edsmodel module -------------------------------- - -.. automodule:: hyperspy.models.edsmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.models.edssemmodel module ----------------------------------- - -.. automodule:: hyperspy.models.edssemmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.models.edstemmodel module ----------------------------------- - -.. automodule:: hyperspy.models.edstemmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.models.eelsmodel module --------------------------------- - -.. automodule:: hyperspy.models.eelsmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.models.model1d module ------------------------------- - -.. automodule:: hyperspy.models.model1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.models.model2d module ------------------------------- - -.. automodule:: hyperspy.models.model2d - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.models - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.rst b/doc/api/hyperspy.rst deleted file mode 100644 index 251db25e2e..0000000000 --- a/doc/api/hyperspy.rst +++ /dev/null @@ -1,217 +0,0 @@ -hyperspy package -================ - -Subpackages ------------ - -.. toctree:: - - hyperspy._components - hyperspy._signals - hyperspy.datasets - hyperspy.docstrings - hyperspy.drawing - hyperspy.external - hyperspy.io_plugins - hyperspy.learn - hyperspy.misc - hyperspy.models - hyperspy.samfire_utils - hyperspy.tests - hyperspy.utils - -Submodules ----------- - -hyperspy.Release module ------------------------ - -.. automodule:: hyperspy.Release - :members: - :undoc-members: - :show-inheritance: - -hyperspy.\_lazy\_signals module -------------------------------- - -.. automodule:: hyperspy._lazy_signals - :members: - :undoc-members: - :show-inheritance: - -hyperspy.api module -------------------- - -.. automodule:: hyperspy.api - :members: - :undoc-members: - :show-inheritance: - -hyperspy.api\_nogui module --------------------------- - -.. automodule:: hyperspy.api_nogui - :members: - :undoc-members: - :show-inheritance: - -hyperspy.axes module --------------------- - -.. automodule:: hyperspy.axes - :members: - :undoc-members: - :show-inheritance: - -hyperspy.component module -------------------------- - -.. automodule:: hyperspy.component - :members: - :undoc-members: - :show-inheritance: - -hyperspy.components1d module ----------------------------- - -.. automodule:: hyperspy.components1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.components2d module ----------------------------- - -.. automodule:: hyperspy.components2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.conftest module ------------------------- - -.. automodule:: hyperspy.conftest - :members: - :undoc-members: - :show-inheritance: - -hyperspy.decorators module --------------------------- - -.. automodule:: hyperspy.decorators - :members: - :undoc-members: - :show-inheritance: - -hyperspy.defaults\_parser module --------------------------------- - -.. automodule:: hyperspy.defaults_parser - :members: - :undoc-members: - :show-inheritance: - -hyperspy.events module ----------------------- - -.. automodule:: hyperspy.events - :members: - :undoc-members: - :show-inheritance: - -hyperspy.exceptions module --------------------------- - -.. automodule:: hyperspy.exceptions - :members: - :undoc-members: - :show-inheritance: - -hyperspy.interactive module ---------------------------- - -.. automodule:: hyperspy.interactive - :members: - :undoc-members: - :show-inheritance: - -hyperspy.io module ------------------- - -.. automodule:: hyperspy.io - :members: - :undoc-members: - :show-inheritance: - -hyperspy.logger module ----------------------- - -.. automodule:: hyperspy.logger - :members: - :undoc-members: - :show-inheritance: - -hyperspy.model module ---------------------- - -.. automodule:: hyperspy.model - :members: - :undoc-members: - :show-inheritance: - -hyperspy.roi module -------------------- - -.. automodule:: hyperspy.roi - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire module ------------------------ - -.. automodule:: hyperspy.samfire - :members: - :undoc-members: - :show-inheritance: - -hyperspy.signal module ----------------------- - -.. automodule:: hyperspy.signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.signal\_tools module ------------------------------ - -.. automodule:: hyperspy.signal_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.signals module ------------------------ - -.. automodule:: hyperspy.signals - :members: - :undoc-members: - :show-inheritance: - -hyperspy.ui\_registry module ----------------------------- - -.. automodule:: hyperspy.ui_registry - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst b/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst deleted file mode 100644 index ec1c265553..0000000000 --- a/doc/api/hyperspy.samfire_utils.goodness_of_fit_tests.rst +++ /dev/null @@ -1,38 +0,0 @@ -hyperspy.samfire\_utils.goodness\_of\_fit\_tests package -======================================================== - -Submodules ----------- - -hyperspy.samfire\_utils.goodness\_of\_fit\_tests.information\_theory module ---------------------------------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.information_theory - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.goodness\_of\_fit\_tests.red\_chisq module ------------------------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.red_chisq - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.goodness\_of\_fit\_tests.test\_general module ---------------------------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests.test_general - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.samfire_utils.goodness_of_fit_tests - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.samfire_utils.rst b/doc/api/hyperspy.samfire_utils.rst deleted file mode 100644 index 75a9a7091d..0000000000 --- a/doc/api/hyperspy.samfire_utils.rst +++ /dev/null @@ -1,79 +0,0 @@ -hyperspy.samfire\_utils package -=============================== - -Subpackages ------------ - -.. toctree:: - - hyperspy.samfire_utils.goodness_of_fit_tests - hyperspy.samfire_utils.segmenters - hyperspy.samfire_utils.weights - -Submodules ----------- - -hyperspy.samfire\_utils.fit\_tests module ------------------------------------------ - -.. automodule:: hyperspy.samfire_utils.fit_tests - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.global\_strategies module -------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.global_strategies - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.local\_strategies module ------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.local_strategies - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.samfire\_kernel module ----------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.samfire_kernel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.samfire\_pool module --------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.samfire_pool - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.samfire\_worker module ----------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.samfire_worker - :members: - :undoc-members: - :show-inheritance: - -hyperspy.samfire\_utils.strategy module ---------------------------------------- - -.. automodule:: hyperspy.samfire_utils.strategy - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.samfire_utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.samfire_utils.segmenters.rst b/doc/api/hyperspy.samfire_utils.segmenters.rst deleted file mode 100644 index 256982e28f..0000000000 --- a/doc/api/hyperspy.samfire_utils.segmenters.rst +++ /dev/null @@ -1,22 +0,0 @@ -hyperspy.samfire\_utils.segmenters package -========================================== - -Submodules ----------- - -hyperspy.samfire\_utils.segmenters.histogram module ---------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.segmenters.histogram - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.samfire_utils.segmenters - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.samfire_utils.weights.rst b/doc/api/hyperspy.samfire_utils.weights.rst deleted file mode 100644 index 75963d9d86..0000000000 --- a/doc/api/hyperspy.samfire_utils.weights.rst +++ /dev/null @@ -1,22 +0,0 @@ -hyperspy.samfire\_utils.weights package -======================================= - -Submodules ----------- - -hyperspy.samfire\_utils.weights.red\_chisq module -------------------------------------------------- - -.. automodule:: hyperspy.samfire_utils.weights.red_chisq - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.samfire_utils.weights - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.axes.rst b/doc/api/hyperspy.tests.axes.rst deleted file mode 100644 index 4014e89c4f..0000000000 --- a/doc/api/hyperspy.tests.axes.rst +++ /dev/null @@ -1,30 +0,0 @@ -hyperspy.tests.axes package -=========================== - -Submodules ----------- - -hyperspy.tests.axes.test\_axes\_manager module ----------------------------------------------- - -.. automodule:: hyperspy.tests.axes.test_axes_manager - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.axes.test\_data\_axis module -------------------------------------------- - -.. automodule:: hyperspy.tests.axes.test_data_axis - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.axes - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.component.rst b/doc/api/hyperspy.tests.component.rst deleted file mode 100644 index 0704370663..0000000000 --- a/doc/api/hyperspy.tests.component.rst +++ /dev/null @@ -1,38 +0,0 @@ -hyperspy.tests.component package -================================ - -Submodules ----------- - -hyperspy.tests.component.test\_component\_active\_array module --------------------------------------------------------------- - -.. automodule:: hyperspy.tests.component.test_component_active_array - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.component.test\_component\_set\_parameters module ----------------------------------------------------------------- - -.. automodule:: hyperspy.tests.component.test_component_set_parameters - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.component.test\_gaussianhf module ------------------------------------------------- - -.. automodule:: hyperspy.tests.component.test_gaussianhf - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.component - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.datasets.rst b/doc/api/hyperspy.tests.datasets.rst deleted file mode 100644 index f08f9306b3..0000000000 --- a/doc/api/hyperspy.tests.datasets.rst +++ /dev/null @@ -1,22 +0,0 @@ -hyperspy.tests.datasets package -=============================== - -Submodules ----------- - -hyperspy.tests.datasets.test\_eelsdb module -------------------------------------------- - -.. automodule:: hyperspy.tests.datasets.test_eelsdb - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.datasets - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.drawing.rst b/doc/api/hyperspy.tests.drawing.rst deleted file mode 100644 index cfa1e6de8c..0000000000 --- a/doc/api/hyperspy.tests.drawing.rst +++ /dev/null @@ -1,94 +0,0 @@ -hyperspy.tests.drawing package -============================== - -Submodules ----------- - -hyperspy.tests.drawing.test\_figure\_title module -------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_figure_title - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_mpl\_testing\_setup module -------------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_mpl_testing_setup - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_markers module -------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_markers - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_model module ------------------------------------------------ - -.. automodule:: hyperspy.tests.drawing.test_plot_model - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_mva module ---------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_mva - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_signal module ------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_signal1d module --------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_signal1d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_signal2d module --------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_signal2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_plot\_widgets module -------------------------------------------------- - -.. automodule:: hyperspy.tests.drawing.test_plot_widgets - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.drawing.test\_utils module ------------------------------------------ - -.. automodule:: hyperspy.tests.drawing.test_utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.drawing - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.io.rst b/doc/api/hyperspy.tests.io.rst deleted file mode 100644 index 74bf7f0a95..0000000000 --- a/doc/api/hyperspy.tests.io.rst +++ /dev/null @@ -1,142 +0,0 @@ -hyperspy.tests.io package -========================= - -Submodules ----------- - -hyperspy.tests.io.generate\_dm\_testing\_files module ------------------------------------------------------ - -.. automodule:: hyperspy.tests.io.generate_dm_testing_files - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_bcf module ----------------------------------- - -.. automodule:: hyperspy.tests.io.test_bcf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_blockfile module ----------------------------------------- - -.. automodule:: hyperspy.tests.io.test_blockfile - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_dens module ------------------------------------ - -.. automodule:: hyperspy.tests.io.test_dens - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_dm3 module ----------------------------------- - -.. automodule:: hyperspy.tests.io.test_dm3 - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_dm\_stackbuilder\_plugin module -------------------------------------------------------- - -.. automodule:: hyperspy.tests.io.test_dm_stackbuilder_plugin - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_edax module ------------------------------------ - -.. automodule:: hyperspy.tests.io.test_edax - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_emd module ----------------------------------- - -.. automodule:: hyperspy.tests.io.test_emd - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_fei module ----------------------------------- - -.. automodule:: hyperspy.tests.io.test_fei - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_hdf5 module ------------------------------------ - -.. automodule:: hyperspy.tests.io.test_hdf5 - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_io module ---------------------------------- - -.. automodule:: hyperspy.tests.io.test_io - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_msa module ----------------------------------- - -.. automodule:: hyperspy.tests.io.test_msa - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_protochips module ------------------------------------------ - -.. automodule:: hyperspy.tests.io.test_protochips - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_ripple module -------------------------------------- - -.. automodule:: hyperspy.tests.io.test_ripple - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_semper\_unf module ------------------------------------------- - -.. automodule:: hyperspy.tests.io.test_semper_unf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.io.test\_tiff module ------------------------------------ - -.. automodule:: hyperspy.tests.io.test_tiff - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.io - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.misc.rst b/doc/api/hyperspy.tests.misc.rst deleted file mode 100644 index 1a9d8d9a6b..0000000000 --- a/doc/api/hyperspy.tests.misc.rst +++ /dev/null @@ -1,70 +0,0 @@ -hyperspy.tests.misc package -=========================== - -Submodules ----------- - -hyperspy.tests.misc.test\_arraytools module -------------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_arraytools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_date\_time\_tools module --------------------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_date_time_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_image\_tools module ---------------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_image_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_math\_tools module --------------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_math_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_rgbtools module ------------------------------------------ - -.. automodule:: hyperspy.tests.misc.test_rgbtools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_test\_utils module --------------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_test_utils - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.misc.test\_utils module --------------------------------------- - -.. automodule:: hyperspy.tests.misc.test_utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.misc - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.model.rst b/doc/api/hyperspy.tests.model.rst deleted file mode 100644 index 022d10e83b..0000000000 --- a/doc/api/hyperspy.tests.model.rst +++ /dev/null @@ -1,134 +0,0 @@ -hyperspy.tests.model package -============================ - -Submodules ----------- - -hyperspy.tests.model.test\_chi\_squared module ----------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_chi_squared - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_component module -------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_component - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_components module --------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_components - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_components2D module ----------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_components2D - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_edsmodel module ------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_edsmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_eelsmodel module -------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_eelsmodel - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_fancy\_indexing module -------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_fancy_indexing - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_fit\_component module ------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_fit_component - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_model module ---------------------------------------- - -.. automodule:: hyperspy.tests.model.test_model - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_model\_as\_dictionary module -------------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_model_as_dictionary - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_model\_selection\_criteria module ------------------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_model_selection_criteria - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_model\_storing module ------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_model_storing - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_parameter module -------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_parameter - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_set\_parameter\_state module -------------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_set_parameter_state - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.model.test\_set\_parameter\_value module -------------------------------------------------------- - -.. automodule:: hyperspy.tests.model.test_set_parameter_value - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.model - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.mva.rst b/doc/api/hyperspy.tests.mva.rst deleted file mode 100644 index 10836ab6db..0000000000 --- a/doc/api/hyperspy.tests.mva.rst +++ /dev/null @@ -1,54 +0,0 @@ -hyperspy.tests.mva package -========================== - -Submodules ----------- - -hyperspy.tests.mva.test\_bss module ------------------------------------ - -.. automodule:: hyperspy.tests.mva.test_bss - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.mva.test\_decomposition module ---------------------------------------------- - -.. automodule:: hyperspy.tests.mva.test_decomposition - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.mva.test\_export module --------------------------------------- - -.. automodule:: hyperspy.tests.mva.test_export - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.mva.test\_onmf module ------------------------------------- - -.. automodule:: hyperspy.tests.mva.test_onmf - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.mva.test\_rpca module ------------------------------------- - -.. automodule:: hyperspy.tests.mva.test_rpca - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.mva - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.rst b/doc/api/hyperspy.tests.rst deleted file mode 100644 index fc5dbb6f19..0000000000 --- a/doc/api/hyperspy.tests.rst +++ /dev/null @@ -1,55 +0,0 @@ -hyperspy.tests package -====================== - -Subpackages ------------ - -.. toctree:: - - hyperspy.tests.axes - hyperspy.tests.component - hyperspy.tests.datasets - hyperspy.tests.drawing - hyperspy.tests.io - hyperspy.tests.misc - hyperspy.tests.model - hyperspy.tests.mva - hyperspy.tests.samfire - hyperspy.tests.signal - hyperspy.tests.utils - -Submodules ----------- - -hyperspy.tests.test\_dictionary\_tree\_browser module ------------------------------------------------------ - -.. automodule:: hyperspy.tests.test_dictionary_tree_browser - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.test\_events module ----------------------------------- - -.. automodule:: hyperspy.tests.test_events - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.test\_interactive module ---------------------------------------- - -.. automodule:: hyperspy.tests.test_interactive - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.samfire.rst b/doc/api/hyperspy.tests.samfire.rst deleted file mode 100644 index aad963ca3e..0000000000 --- a/doc/api/hyperspy.tests.samfire.rst +++ /dev/null @@ -1,70 +0,0 @@ -hyperspy.tests.samfire package -============================== - -Submodules ----------- - -hyperspy.tests.samfire.test\_goodness\_of\_fit\_tests module ------------------------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_goodness_of_fit_tests - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_histogram\_segmenter module --------------------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_histogram_segmenter - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_red\_chisq\_weight module ------------------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_red_chisq_weight - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_samfire module -------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_samfire - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_strategy module --------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_strategy - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_strategy\_list module --------------------------------------------------- - -.. automodule:: hyperspy.tests.samfire.test_strategy_list - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.samfire.test\_utils module ------------------------------------------ - -.. automodule:: hyperspy.tests.samfire.test_utils - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.samfire - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.signal.rst b/doc/api/hyperspy.tests.signal.rst deleted file mode 100644 index b627ee4ace..0000000000 --- a/doc/api/hyperspy.tests.signal.rst +++ /dev/null @@ -1,206 +0,0 @@ -hyperspy.tests.signal package -============================= - -Submodules ----------- - -hyperspy.tests.signal.test\_1D\_tools module --------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_1D_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_2D\_tools module --------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_2D_tools - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_assign\_subclass module ---------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_assign_subclass - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_binned module ------------------------------------------ - -.. automodule:: hyperspy.tests.signal.test_binned - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_complex\_signal module --------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_complex_signal - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_complex\_signal2d module ----------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_complex_signal2d - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_eds\_sem module -------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_eds_sem - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_eds\_tem module -------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_eds_tem - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_eels module ---------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_eels - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_fancy\_indexing module --------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_fancy_indexing - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_find\_peaks1D\_ohaver module --------------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_find_peaks1D_ohaver - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_folding module ------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_folding - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_hologram\_image module --------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_hologram_image - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_image module ----------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_image - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_inheritance module ----------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_inheritance - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_kramers\_kronig\_transform module -------------------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_kramers_kronig_transform - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_lazy module ---------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_lazy - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_map\_method module ----------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_map_method - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_remove\_background module ------------------------------------------------------ - -.. automodule:: hyperspy.tests.signal.test_remove_background - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_rgb module --------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_rgb - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_signal\_operators module ----------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_signal_operators - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_signal\_subclass\_conversion module ---------------------------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_signal_subclass_conversion - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_spectrum module -------------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_spectrum - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.signal.test\_tools module ----------------------------------------- - -.. automodule:: hyperspy.tests.signal.test_tools - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.signal - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.tests.utils.rst b/doc/api/hyperspy.tests.utils.rst deleted file mode 100644 index c6fd7c38e1..0000000000 --- a/doc/api/hyperspy.tests.utils.rst +++ /dev/null @@ -1,62 +0,0 @@ -hyperspy.tests.utils package -============================ - -Submodules ----------- - -hyperspy.tests.utils.test\_attrsetter module --------------------------------------------- - -.. automodule:: hyperspy.tests.utils.test_attrsetter - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.utils.test\_eds module -------------------------------------- - -.. automodule:: hyperspy.tests.utils.test_eds - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.utils.test\_material module ------------------------------------------- - -.. automodule:: hyperspy.tests.utils.test_material - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.utils.test\_roi module -------------------------------------- - -.. automodule:: hyperspy.tests.utils.test_roi - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.utils.test\_slugify module ------------------------------------------ - -.. automodule:: hyperspy.tests.utils.test_slugify - :members: - :undoc-members: - :show-inheritance: - -hyperspy.tests.utils.test\_stack module ---------------------------------------- - -.. automodule:: hyperspy.tests.utils.test_stack - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.tests.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/hyperspy.utils.rst b/doc/api/hyperspy.utils.rst deleted file mode 100644 index ce7886ed50..0000000000 --- a/doc/api/hyperspy.utils.rst +++ /dev/null @@ -1,86 +0,0 @@ -hyperspy.utils package -====================== - -Submodules ----------- - -hyperspy.utils.eds module -------------------------- - -.. automodule:: hyperspy.utils.eds - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.markers module ------------------------------ - -.. automodule:: hyperspy.utils.markers - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.material module ------------------------------- - -.. automodule:: hyperspy.utils.material - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.model module ---------------------------- - -.. automodule:: hyperspy.utils.model - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.model\_selection module --------------------------------------- - -.. automodule:: hyperspy.utils.model_selection - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.parallel\_pool module ------------------------------------- - -.. automodule:: hyperspy.utils.parallel_pool - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.plot module --------------------------- - -.. automodule:: hyperspy.utils.plot - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.roi module -------------------------- - -.. automodule:: hyperspy.utils.roi - :members: - :undoc-members: - :show-inheritance: - -hyperspy.utils.samfire module ------------------------------ - -.. automodule:: hyperspy.utils.samfire - :members: - :undoc-members: - :show-inheritance: - - -Module contents ---------------- - -.. automodule:: hyperspy.utils - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/api/modules.rst b/doc/api/modules.rst deleted file mode 100644 index f77938b64b..0000000000 --- a/doc/api/modules.rst +++ /dev/null @@ -1,7 +0,0 @@ -hyperspy -======== - -.. toctree:: - :maxdepth: 4 - - hyperspy diff --git a/doc/conf.py b/doc/conf.py index 4d2f6e021b..9f0fda45ea 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -234,6 +234,17 @@ intersphinx_mapping = {'hyperspyweb': ('http://hyperspy.org/', None), 'matplotlib': ('https://matplotlib.org', None)} +# -- Options for Sphinx API doc ---------------------------------------------- +# Adapted from https://github.com/isogeo/isogeo-api-py-minsdk/blob/master/docs/conf.py +# run api doc +def run_apidoc(_): + from sphinx.ext.apidoc import main + + cur_dir = os.path.normpath(os.path.dirname(__file__)) + output_path = os.path.join(cur_dir, 'api') + modules = os.path.normpath(os.path.join(cur_dir, "../hyperspy")) + main(['-e', '-f', '-P', '-o', output_path, modules]) def setup(app): + app.connect('builder-inited', run_apidoc) app.add_javascript('copybutton.js') diff --git a/doc/generate_api_doc.sh b/doc/generate_api_doc.sh deleted file mode 100755 index 636fe9d039..0000000000 --- a/doc/generate_api_doc.sh +++ /dev/null @@ -1,4 +0,0 @@ -# This only works with Sphinx >= 1.1 - -rm api/*.rst -sphinx-apidoc ../hyperspy -o api -s rst -f --private diff --git a/doc/gh-pages.py b/doc/gh-pages.py index d7eba70158..6bb91b2ef3 100755 --- a/doc/gh-pages.py +++ b/doc/gh-pages.py @@ -79,7 +79,6 @@ def init_repo(path): # Script starts #----------------------------------------------------------------------------- if __name__ == '__main__': - sh('./generate_api_doc.sh') # The tag can be given as a positional argument try: tag = sys.argv[1] From 0d02e7659ca4bacba0e5cecac7a6e22b8671894b Mon Sep 17 00:00:00 2001 From: autopep8 Date: Tue, 28 Aug 2018 18:42:27 +0200 Subject: [PATCH 02/13] Automatic style corrections courtesy of autopep8 --- doc/conf.py | 3 +++ doc/gh-pages.py | 1 + 2 files changed, 4 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 9f0fda45ea..1636b20d66 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -237,6 +237,8 @@ # -- Options for Sphinx API doc ---------------------------------------------- # Adapted from https://github.com/isogeo/isogeo-api-py-minsdk/blob/master/docs/conf.py # run api doc + + def run_apidoc(_): from sphinx.ext.apidoc import main @@ -245,6 +247,7 @@ def run_apidoc(_): modules = os.path.normpath(os.path.join(cur_dir, "../hyperspy")) main(['-e', '-f', '-P', '-o', output_path, modules]) + def setup(app): app.connect('builder-inited', run_apidoc) app.add_javascript('copybutton.js') diff --git a/doc/gh-pages.py b/doc/gh-pages.py index 6bb91b2ef3..32df6d5e14 100755 --- a/doc/gh-pages.py +++ b/doc/gh-pages.py @@ -75,6 +75,7 @@ def init_repo(path): sh('git checkout gh-pages') cd(here) + #----------------------------------------------------------------------------- # Script starts #----------------------------------------------------------------------------- From 6e4689a479da61dc492c02b276925182cd9e80ae Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Tue, 28 Aug 2018 18:50:59 +0200 Subject: [PATCH 03/13] Set sphinx req for docs --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index ea25f6d511..1e5b0ee737 100644 --- a/setup.py +++ b/setup.py @@ -71,7 +71,7 @@ "mrcz-blosc": ["blosc>=1.5"], "lazy_FEI_EMD": ['sparse'], "test": ["pytest>=3", "pytest-mpl", "matplotlib>=2.0.2"], - "doc": ["sphinx", "numpydoc", "sphinxcontrib-napoleon", "sphinx_rtd_theme"], + "doc": ["sphinx>=1.7", "numpydoc", "sphinxcontrib-napoleon", "sphinx_rtd_theme"], } extras_require["all"] = list(itertools.chain(*list(extras_require.values()))) From 73fd6d3cc0ad590c432f2af37c9ceb08e4ff894f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Tue, 28 Aug 2018 19:05:27 +0200 Subject: [PATCH 04/13] Add doc/api to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 4c88d23e7d..47b6132109 100755 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ data/octave-core .spyderproject doc/_build/* doc/.build/* +doc/api/* doc/user_guide/_build/* doc/user_guide/.build/* setup/windows/requires/* From 02fc77fd33697bfe0936cb65afdc5ebd0b15611c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 10:57:42 +0200 Subject: [PATCH 05/13] Git ignore VSCode --- .gitignore | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.gitignore b/.gitignore index 47b6132109..3facde3bf7 100755 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,10 @@ hyperspy/io_plugins/unbcf_fast.c hyperspy/misc/etc/test_compilers.obj /.cache/ /.spyproject/ + +### Code ### +# Visual Studio Code - https://code.visualstudio.com/ +.settings/ +.vscode/ +tsconfig.json +jsconfig.json From 0ca1bc9d591a5aeb9ab2178e677d52b975247409 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:01:52 +0200 Subject: [PATCH 06/13] numpydoc and napoleon no longer required --- doc/conf.py | 2 +- doc/pip-req.txt | 2 -- setup.py | 2 +- 3 files changed, 2 insertions(+), 4 deletions(-) delete mode 100644 doc/pip-req.txt diff --git a/doc/conf.py b/doc/conf.py index 1636b20d66..e56a3c4935 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -31,7 +31,7 @@ # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - 'sphinxcontrib.napoleon', + 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx', 'sphinx.ext.imgmath', 'sphinx.ext.autosummary', diff --git a/doc/pip-req.txt b/doc/pip-req.txt deleted file mode 100644 index 4fd781b8ff..0000000000 --- a/doc/pip-req.txt +++ /dev/null @@ -1,2 +0,0 @@ -sphinxcontrib-napoleon - diff --git a/setup.py b/setup.py index 1e5b0ee737..899c177a9f 100644 --- a/setup.py +++ b/setup.py @@ -71,7 +71,7 @@ "mrcz-blosc": ["blosc>=1.5"], "lazy_FEI_EMD": ['sparse'], "test": ["pytest>=3", "pytest-mpl", "matplotlib>=2.0.2"], - "doc": ["sphinx>=1.7", "numpydoc", "sphinxcontrib-napoleon", "sphinx_rtd_theme"], + "doc": ["sphinx>=1.7", "sphinx_rtd_theme"], } extras_require["all"] = list(itertools.chain(*list(extras_require.values()))) From 056ba1bf6b10279ba2dac466c2c93a088b07ba86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:13:55 +0200 Subject: [PATCH 07/13] Add hyperspy to requirements --- doc/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..971715208d --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,2 @@ +hyperspy + From b7798fd7890ba40448808a8d7ed72fb217ff77f5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:26:15 +0200 Subject: [PATCH 08/13] Test adding requirements --- doc/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 971715208d..be1466ece9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,2 +1,3 @@ -hyperspy +dask +traits From 92bcd70c002c735c2fee0a699dcf7cfe992b4eb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:29:38 +0200 Subject: [PATCH 09/13] Test uncommenting RtD hack --- doc/requirements.txt | 2 -- setup.py | 4 ++-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index be1466ece9..8b13789179 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,3 +1 @@ -dask -traits diff --git a/setup.py b/setup.py index 899c177a9f..1d759102e3 100644 --- a/setup.py +++ b/setup.py @@ -76,8 +76,8 @@ extras_require["all"] = list(itertools.chain(*list(extras_require.values()))) # the hack to deal with setuptools + installing the package in ReadTheDoc: -if 'readthedocs.org' in sys.executable: - install_req = [] +# if 'readthedocs.org' in sys.executable: +# install_req = [] def update_version(version): From 6c7e9943a1b0f74e11da77fe42e94eb85f11f56d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:40:36 +0200 Subject: [PATCH 10/13] Test pinning mpl version --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 1d759102e3..7589aa3ffc 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ import hyperspy.Release as Release install_req = ['scipy>=0.15', - 'matplotlib>=2.2.3', + 'matplotlib==2.2.3', 'numpy>=1.10, !=1.13.0', 'traits>=4.5.0', 'natsort', From 60bb3843861ba733add25ebd2d4d7ca1379a7724 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 11:53:02 +0200 Subject: [PATCH 11/13] Use pip to install in RtD --- doc/readthedocs.yml | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 doc/readthedocs.yml diff --git a/doc/readthedocs.yml b/doc/readthedocs.yml new file mode 100644 index 0000000000..12bc41edb0 --- /dev/null +++ b/doc/readthedocs.yml @@ -0,0 +1,3 @@ +python: + pip_install: true + From 85f39e9fd8edec990994a5aae07f0d77432422cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 12:09:12 +0200 Subject: [PATCH 12/13] Remove unnecessary version pinning and obsolate code --- setup.py | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/setup.py b/setup.py index 7589aa3ffc..e346688726 100644 --- a/setup.py +++ b/setup.py @@ -46,7 +46,7 @@ import hyperspy.Release as Release install_req = ['scipy>=0.15', - 'matplotlib==2.2.3', + 'matplotlib>=2.2.3', 'numpy>=1.10, !=1.13.0', 'traits>=4.5.0', 'natsort', @@ -75,10 +75,6 @@ } extras_require["all"] = list(itertools.chain(*list(extras_require.values()))) -# the hack to deal with setuptools + installing the package in ReadTheDoc: -# if 'readthedocs.org' in sys.executable: -# install_req = [] - def update_version(version): release_path = "hyperspy/Release.py" From 2d1e57df856d39250c2b66967235e421d9f02b0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Francisco=20de=20la=20Pe=C3=B1a?= Date: Wed, 29 Aug 2018 12:14:01 +0200 Subject: [PATCH 13/13] Remove unnecessary requirements file --- doc/requirements.txt | 1 - 1 file changed, 1 deletion(-) delete mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt deleted file mode 100644 index 8b13789179..0000000000 --- a/doc/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -