Change version in doc + remove main functions from coverage + small doc errors corrections

copyright.py

@@ -69,7 +69,10 @@ def getVersionsAndDate():
 
 
 def writeCopyrightRst(date, ltfatpy_version, ltfat_version):
-    stamp = open("copyrightstamp.txt").read()
+    stamp = ""
+    for line in open("copyrightstamp.txt"):
+        if "# COPYRIGHT #" not in line:
+            stamp += line
     stamp = stamp.replace("DATE", date)
     stamp = stamp.replace("LTFATPY_VERSION", ltfatpy_version)
     stamp = stamp.replace("LTFAT_VERSION", ltfat_version)

copyrightstamp.txt

 ######### COPYRIGHT #########
 
 Copyright(c) DATE:
------------------
+------------------
 
 * LabEx Archimède: http://labex-archimede.univ-amu.fr/
 * Laboratoire d'Informatique Fondamentale : http://www.lif.univ-mrs.fr/
@@ -12,26 +12,26 @@ This software is a port from LTFAT LTFAT_VERSION :
 Copyright (C) 2005-DATE Peter L. Soendergaard <peter@sonderport.dk>.
 
 Contributors:
-------------
+-------------
 
 * Denis Arrivault <contact.dev_AT_lif.univ-mrs.fr>
 * Florent Jaillet <contact.dev_AT_lif.univ-mrs.fr>
 
 Description:
------------
+------------
 
 ltfatpy is a partial Python port of the Large Time/Frequency Analysis Toolbox
 (http://ltfat.sourceforge.net/), a MATLAB®/Octave toolbox for working with
 time-frequency analysis and synthesis.
 
 Version:
--------
+--------
 
 * ltfatpy version = LTFATPY_VERSION
 * LTFAT version = LTFAT_VERSION
 
 Licence:
--------
+--------
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

doc/conf.py

@@ -17,6 +17,16 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
+# import os
+# 
+# 
+# def get_version():
+#     versionFile = os.path.join(os.pardir, 'VERSION')
+#     v_text = open(versionFile).read().strip()
+#     v_text_formted = '{"' + v_text.replace('\n', '","').replace(':', '":"')
+#     v_text_formted += '"}'
+#     v_dict = eval(v_text_formted)
+#     return v_dict["ltfatpy"]
 
 # -- General configuration ------------------------------------------------
 
@@ -61,9 +71,10 @@ copyright = u'2015, D. Arrivault, F. Jaillet'
 # built documents.
 #
 # The short X.Y version.
-version = '1.0.0'
+import ltfatpy
+version = ltfatpy.__version__
 # The full version, including alpha/beta/rc tags.
-release = '1.0.0'
+release = version
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -138,7 +149,7 @@ html_theme = "nature"
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

doc/copyright.rst

-######### COPYRIGHT #########
 
 Copyright(c) 2016:
------------------
+------------------
 
 * LabEx Archimède: http://labex-archimede.univ-amu.fr/
 * Laboratoire d'Informatique Fondamentale : http://www.lif.univ-mrs.fr/
@@ -12,26 +11,26 @@ This software is a port from LTFAT 2.1.0 :
 Copyright (C) 2005-2016 Peter L. Soendergaard <peter@sonderport.dk>.
 
 Contributors:
-------------
+-------------
 
 * Denis Arrivault <contact.dev_AT_lif.univ-mrs.fr>
 * Florent Jaillet <contact.dev_AT_lif.univ-mrs.fr>
 
 Description:
------------
+------------
 
 ltfatpy is a partial Python port of the Large Time/Frequency Analysis Toolbox
 (http://ltfat.sourceforge.net/), a MATLAB®/Octave toolbox for working with
 time-frequency analysis and synthesis.
 
 Version:
--------
+--------
 
 * ltfatpy version = 1.0.4
 * LTFAT version = 2.1.0
 
 Licence:
--------
+--------
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -46,4 +45,3 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-######### COPYRIGHT #########
\ No newline at end of file

doc/install.rst

@@ -60,3 +60,5 @@ Before building documentation you have to install **sphinxcontrib-bibtex** :
 
 Then you have to use the setup.py build_sphinx command :
 ``python setup.py build_sphinx``
+
+If errors occur, make sure you installed ltfatpy before building the sphinx documentation.

ltfatpy/__init__.py

@@ -117,4 +117,4 @@ __all__ = ["arg_firwin", "assert_groworder", "assert_sigreshape_post",
            "long2fir", "normalize", "rms", "thresh", "lcm", "postpad"]
 
 
-__version__ = "1.0.3"
+__version__ = "1.0.4"

ltfatpy/fourier/dcti.py

@@ -118,6 +118,6 @@ def dcti(f, L=None, dim=None):
         c = comp_dct(f, 1)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dctii.py

@@ -116,6 +116,6 @@ def dctii(f, L=None, dim=None):
 
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dctiii.py

@@ -110,6 +110,6 @@ def dctiii(f, L=None, dim=None):
         c = comp_dct(f, 3)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dctiv.py

@@ -98,6 +98,6 @@ def dctiv(f, L=None, dim=None):
         c = comp_dct(f, 4)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dsti.py

@@ -105,6 +105,6 @@ def dsti(f, L=None, dim=None):
         c = comp_dst(f, 1)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dstii.py

@@ -108,6 +108,6 @@ def dstii(f, L=None, dim=None):
         c = comp_dst(f, 2)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dstiii.py

@@ -108,6 +108,6 @@ def dstiii(f, L=None, dim=None):
         c = comp_dst(f, 3)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/dstiv.py

@@ -99,6 +99,6 @@ def dstiv(f, L=None, dim=None):
         c = comp_dst(f, 4)
     return assert_sigreshape_post(c, dim, permutedsize, order)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/pgauss.py

@@ -145,6 +145,6 @@ def pgauss(L, tfr=1.0, fs=0.0, width=0.0, bw=0.0, c_f=0.0, centering='wp',
     g = normalize(g, norm)[0]
     return(g, tfr)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/pherm.py

@@ -217,6 +217,6 @@ def get_safe(order):
                     safe = 12
     return safe
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/fourier/psech.py

@@ -106,6 +106,6 @@ def psech(L, tfr=None, s=None, **kwargs):
     g = g * np.sqrt(np.pi / (2 * np.sqrt(L*w)))
     return(g, tfr)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/gabor/dgt.py

@@ -192,6 +192,6 @@ def dgt(f, g, a, M, L=None, pt='freqinv'):
 
     return (c, Ls, gnum)
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/gabor/dgtreal.py

@@ -137,6 +137,6 @@ def dgtreal(f, g, a, M, L=None, pt='freqinv'):
     return (c, Ls, gnum)
 
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()

ltfatpy/gabor/gabdual.py

@@ -140,6 +140,6 @@ def _call_gabwin(g, a, M, L):
     return gabwin(g, a, M, L)
 
 
-if __name__ == '__main__':
+if __name__ == '__main__':  # pragma: no cover
     import doctest
     doctest.testmod()