Merge pull request #152 from jaidevd/jd-fix-timestamps

Fix timestamp displays in plots

doc/_gallery/plot_1_3_3_transient.py

@@ -13,6 +13,7 @@
 
 This example shows how to generate a noisy transient signal with the following
 characteristics:
+
     * One-sided exponential amplitude modulation (See :ref:`amexpos`)
     * Constant frequency modulation (See :ref:`fmconst`)
     * -5 dB complex gaussian noise (See :ref:`noisecg` and :ref:`sigmerge`)

doc/_gallery/plot_2_2_1_time_freq_localization.py

@@ -13,6 +13,7 @@
 
 Generate a signal that has localized characteristics in both time and frequency
 and compute the following estimates:
+
     * time center
     * time duration
     * frequency center

doc/api.rst

@@ -6,3 +6,4 @@ API Reference
     :maxdepth: 2
 
     apiref/tftb
+    apiref/modules

doc/apiref/tftb.generators.rst

@@ -1,5 +1,5 @@
-tftb.generators package
-=======================
+tftb\.generators package
+========================
 
 Subpackages
 -----------
@@ -11,48 +11,48 @@ Subpackages
 Submodules
 ----------
 
-tftb.generators.amplitude_modulated module
-------------------------------------------
+tftb\.generators\.amplitude\_modulated module
+---------------------------------------------
 
 .. automodule:: tftb.generators.amplitude_modulated
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.analytic_signals module
----------------------------------------
+tftb\.generators\.analytic\_signals module
+------------------------------------------
 
 .. automodule:: tftb.generators.analytic_signals
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.frequency_modulated module
-------------------------------------------
+tftb\.generators\.frequency\_modulated module
+---------------------------------------------
 
 .. automodule:: tftb.generators.frequency_modulated
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.misc module
----------------------------
+tftb\.generators\.misc module
+-----------------------------
 
 .. automodule:: tftb.generators.misc
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.noise module
-----------------------------
+tftb\.generators\.noise module
+------------------------------
 
 .. automodule:: tftb.generators.noise
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.utils module
-----------------------------
+tftb\.generators\.utils module
+------------------------------
 
 .. automodule:: tftb.generators.utils
     :members:

doc/apiref/tftb.generators.tests.rst

@@ -1,51 +1,51 @@
-tftb.generators.tests package
-=============================
+tftb\.generators\.tests package
+===============================
 
 Submodules
 ----------
 
-tftb.generators.tests.test_amplitude_modulations module
--------------------------------------------------------
+tftb\.generators\.tests\.test\_amplitude\_modulations module
+------------------------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_amplitude_modulations
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.tests.test_analytic_signals module
---------------------------------------------------
+tftb\.generators\.tests\.test\_analytic\_signals module
+-------------------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_analytic_signals
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.tests.test_frequency_modulations module
--------------------------------------------------------
+tftb\.generators\.tests\.test\_frequency\_modulations module
+------------------------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_frequency_modulations
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.tests.test_misc module
---------------------------------------
+tftb\.generators\.tests\.test\_misc module
+------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_misc
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.tests.test_noise module
----------------------------------------
+tftb\.generators\.tests\.test\_noise module
+-------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_noise
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.generators.tests.test_utils module
----------------------------------------
+tftb\.generators\.tests\.test\_utils module
+-------------------------------------------
 
 .. automodule:: tftb.generators.tests.test_utils
     :members:

doc/apiref/tftb.processing.rst

@@ -1,91 +1,91 @@
-tftb.processing package
-=======================
+tftb\.processing package
+========================
 
 Submodules
 ----------
 
-tftb.processing.affine module
------------------------------
+tftb\.processing\.affine module
+-------------------------------
 
 .. automodule:: tftb.processing.affine
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.ambiguity module
---------------------------------
+tftb\.processing\.ambiguity module
+----------------------------------
 
 .. automodule:: tftb.processing.ambiguity
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.base module
----------------------------
+tftb\.processing\.base module
+-----------------------------
 
 .. automodule:: tftb.processing.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.cohen module
-----------------------------
+tftb\.processing\.cohen module
+------------------------------
 
 .. automodule:: tftb.processing.cohen
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.freq_domain module
-----------------------------------
+tftb\.processing\.freq\_domain module
+-------------------------------------
 
 .. automodule:: tftb.processing.freq_domain
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.linear module
------------------------------
+tftb\.processing\.linear module
+-------------------------------
 
 .. automodule:: tftb.processing.linear
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.plotifl module
-------------------------------
+tftb\.processing\.plotifl module
+--------------------------------
 
 .. automodule:: tftb.processing.plotifl
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.postprocessing module
--------------------------------------
+tftb\.processing\.postprocessing module
+---------------------------------------
 
 .. automodule:: tftb.processing.postprocessing
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.reassigned module
----------------------------------
+tftb\.processing\.reassigned module
+-----------------------------------
 
 .. automodule:: tftb.processing.reassigned
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.time_domain module
-----------------------------------
+tftb\.processing\.time\_domain module
+-------------------------------------
 
 .. automodule:: tftb.processing.time_domain
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.processing.utils module
-----------------------------
+tftb\.processing\.utils module
+------------------------------
 
 .. automodule:: tftb.processing.utils
     :members:

doc/apiref/tftb.rst

@@ -13,8 +13,8 @@ Subpackages
 Submodules
 ----------
 
-tftb.utils module
------------------
+tftb\.utils module
+------------------
 
 .. automodule:: tftb.utils
     :members:

doc/apiref/tftb.tests.rst

@@ -1,19 +1,19 @@
-tftb.tests package
-==================
+tftb\.tests package
+===================
 
 Submodules
 ----------
 
-tftb.tests.base module
-----------------------
+tftb\.tests\.base module
+------------------------
 
 .. automodule:: tftb.tests.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-tftb.tests.test_utils module
-----------------------------
+tftb\.tests\.test\_utils module
+-------------------------------
 
 .. automodule:: tftb.tests.test_utils
     :members:

doc/conf.py

@@ -44,7 +44,9 @@
     # path to your examples scripts
     'examples_dirs' : './_gallery',
     # path where to save gallery generated examples
-    'gallery_dirs'  : 'auto_examples'}
+    'gallery_dirs'  : 'auto_examples',
+    'backreferences_dir': "backreferences",
+    "doc_module": ("tftb")}
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']