more changes for pypi

sunyucheng · Jul 1, 2017 · ed8e42d · ed8e42d
1 parent af1d1a0
commit ed8e42d
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 33 deletions.
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1,5 @@
+include README.rst
+include LICENSE.txt
+
+recursive-include docs *.ipynb *.rst conf.py Makefile
+recursive-exclude docs *checkpoint.ipynb
diff --git a/README.md → README.rst b/README.md → README.rst
@@ -9,7 +9,13 @@ A deep learning for raw time-domain EEG decoding toolbox.
 Installation
 ============
 
-Install pytorch from http://pytorch.org/.
+First, install pytorch from http://pytorch.org/.
+Then, install braindecode via pip:
+
+.. code-block:: bash
+
+  pip install braindecode
+
 
 Documentation
 =============

diff --git a/braindecode/models/__init__.py b/braindecode/models/__init__.py
diff --git a/docs/source/braindecode.datasets.rst b/docs/source/braindecode.datasets.rst
@@ -0,0 +1,22 @@
+braindecode\.datasets package
+=============================
+
+Submodules
+----------
+
+braindecode\.datasets\.signal\_target module
+--------------------------------------------
+
+.. automodule:: braindecode.datasets.signal_target
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: braindecode.datasets
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/source/braindecode.modules.rst b/docs/source/braindecode.modules.rst
diff --git a/docs/source/braindecode.rst b/docs/source/braindecode.rst
@@ -6,14 +6,9 @@ Subpackages
 
 .. toctree::
 
-    braindecode.configs
-    braindecode.csp
     braindecode.datasets
     braindecode.experiments
     braindecode.models
-    braindecode.modules
-    braindecode.mywyrm
-    braindecode.test
     braindecode.torchext
 
 Submodules

diff --git a/docs/source/braindecode.torchext.rst b/docs/source/braindecode.torchext.rst
@@ -28,6 +28,14 @@ braindecode\.torchext\.losses module
     :undoc-members:
     :show-inheritance:
 
+braindecode\.torchext\.modules module
+-------------------------------------
+
+.. automodule:: braindecode.torchext.modules
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 braindecode\.torchext\.util module
 ----------------------------------
 

diff --git a/setup.py b/setup.py
@@ -1,11 +1,11 @@
-from setuptools import setup  # Always prefer setuptools over distutils
+from setuptools import setup, find_packages  # Always prefer setuptools over distutils
 from codecs import open  # To use a consistent encoding
 from os import path
 
 here = path.abspath(path.dirname(__file__))
 
 # Get the long description from the relevant file
-with open(path.join(here, 'README.md'), encoding='utf-8') as f:
+with open(path.join(here, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
 
 
@@ -15,7 +15,7 @@
     # Versions should comply with PEP440.  For a discussion on single-sourcing
     # the version across setup.py and the project code, see
     # http://packaging.python.org/en/latest/tutorial.html#version
-    version='0.1.1',
+    version='0.1.2',
 
     description='A deep learning for raw time-domain EEG decoding toolbox.',
     long_description=long_description,  #this is the
@@ -56,6 +56,7 @@
     # What does your project relate to?
     keywords='eeg deep-learning brain-state-decoding',
 
-    packages=['braindecode'],
-
+    packages=find_packages(),
+    include_package_data=False,
+    zip_safe=False,
 )