Merge pull request #780 from francisco-dlp/DOC_dont_ignore_api

Correct .gitignore that was ignoring the API docs and /bin files

.gitignore

@@ -2,7 +2,6 @@ syntax: glob
 .spyderworkspace
 .coverage
 /MANIFEST
-/*.rst
 *.pyc
 *.pyd
 *.swp
@@ -14,7 +13,7 @@ dist
 *.deb
 *.swo
 build/*
-bin/*
+bin/*.bat
 PortableInstall/*
 hyperspy.egg-info/*
 deb_dist/*
@@ -25,11 +24,11 @@ doc/_build/*
 doc/.build/*
 doc/user_guide/_build/*
 doc/user_guide/.build/*
-doc/api/*.rst
 setup/windows/requires/*
 setup/windows/reccomends/*
 doc/examples
 doc/gh-pages
+doc/log.txt
 *Thumbs.db
 .ropeproject/*
 .idea/*

doc/api/hyperspy._components.rst

@@ -0,0 +1,190 @@
+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_offset module
+----------------------------------------------
+
+.. automodule:: hyperspy._components.eels_double_offset
+    :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.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.spline module
+----------------------------------
+
+.. automodule:: hyperspy._components.spline
+    :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:

doc/api/hyperspy._signals.rst

@@ -0,0 +1,110 @@
+hyperspy._signals package
+=========================
+
+Submodules
+----------
+
+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.eels_spectrum_simulation module
+-------------------------------------------------
+
+.. automodule:: hyperspy._signals.eels_spectrum_simulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.image module
+------------------------------
+
+.. automodule:: hyperspy._signals.image
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.image_simulation module
+-----------------------------------------
+
+.. automodule:: hyperspy._signals.image_simulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.pes module
+----------------------------
+
+.. automodule:: hyperspy._signals.pes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.simulation module
+-----------------------------------
+
+.. automodule:: hyperspy._signals.simulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.spectrum module
+---------------------------------
+
+.. automodule:: hyperspy._signals.spectrum
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+hyperspy._signals.spectrum_simulation module
+--------------------------------------------
+
+.. automodule:: hyperspy._signals.spectrum_simulation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hyperspy._signals
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/hyperspy.datasets.rst

@@ -0,0 +1,22 @@
+hyperspy.datasets package
+=========================
+
+Submodules
+----------
+
+hyperspy.datasets.example_signals module
+----------------------------------------
+
+.. automodule:: hyperspy.datasets.example_signals
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: hyperspy.datasets
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/hyperspy.docstrings.rst

@@ -0,0 +1,10 @@
+hyperspy.docstrings package
+===========================
+
+Module contents
+---------------
+
+.. automodule:: hyperspy.docstrings
+    :members:
+    :undoc-members:
+    :show-inheritance: