Skip to content

Commit f8418a4

Browse files
jaidevdjaidevd
committedJun 28, 2021
DOC: Fix docstring plots, update sphinx build
1 parent aae13a6 commit f8418a4

28 files changed

+93
-720
lines changed
 

‎.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,4 @@ target/
6363
.noseids
6464
cover/
6565
result_images/
66+
docs/apiref/

‎docs/Makefile

+14-171
Original file line numberDiff line numberDiff line change
@@ -1,177 +1,20 @@
1-
# Makefile for Sphinx documentation
1+
# Minimal makefile for Sphinx documentation
22
#
33

4-
# You can set these variables from the command line.
5-
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
7-
PAPER =
8-
BUILDDIR = build
9-
10-
# User-friendly check for sphinx-build
11-
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12-
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13-
endif
14-
15-
# Internal variables.
16-
PAPEROPT_a4 = -D latex_paper_size=a4
17-
PAPEROPT_letter = -D latex_paper_size=letter
18-
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19-
# the i18n builder cannot share the environment and doctrees with the others
20-
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21-
22-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
2310

11+
# Put it first so that "make" without argument is like "make help".
2412
help:
25-
@echo "Please use \`make <target>' where <target> is one of"
26-
@echo " html to make standalone HTML files"
27-
@echo " dirhtml to make HTML files named index.html in directories"
28-
@echo " singlehtml to make a single large HTML file"
29-
@echo " pickle to make pickle files"
30-
@echo " json to make JSON files"
31-
@echo " htmlhelp to make HTML files and a HTML help project"
32-
@echo " qthelp to make HTML files and a qthelp project"
33-
@echo " devhelp to make HTML files and a Devhelp project"
34-
@echo " epub to make an epub"
35-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36-
@echo " latexpdf to make LaTeX files and run them through pdflatex"
37-
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38-
@echo " text to make text files"
39-
@echo " man to make manual pages"
40-
@echo " texinfo to make Texinfo files"
41-
@echo " info to make Texinfo files and run them through makeinfo"
42-
@echo " gettext to make PO message catalogs"
43-
@echo " changes to make an overview of all changed/added/deprecated items"
44-
@echo " xml to make Docutils-native XML files"
45-
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
46-
@echo " linkcheck to check all external links for integrity"
47-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
48-
49-
clean:
50-
rm -rf $(BUILDDIR)/*
51-
52-
html:
53-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
54-
@echo
55-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
56-
57-
dirhtml:
58-
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
59-
@echo
60-
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
61-
62-
singlehtml:
63-
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
64-
@echo
65-
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
66-
67-
pickle:
68-
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
69-
@echo
70-
@echo "Build finished; now you can process the pickle files."
71-
72-
json:
73-
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
74-
@echo
75-
@echo "Build finished; now you can process the JSON files."
76-
77-
htmlhelp:
78-
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
79-
@echo
80-
@echo "Build finished; now you can run HTML Help Workshop with the" \
81-
".hhp project file in $(BUILDDIR)/htmlhelp."
82-
83-
qthelp:
84-
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
85-
@echo
86-
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
87-
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
88-
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pyhht.qhcp"
89-
@echo "To view the help file:"
90-
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pyhht.qhc"
91-
92-
devhelp:
93-
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
94-
@echo
95-
@echo "Build finished."
96-
@echo "To view the help file:"
97-
@echo "# mkdir -p $$HOME/.local/share/devhelp/pyhht"
98-
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pyhht"
99-
@echo "# devhelp"
100-
101-
epub:
102-
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
103-
@echo
104-
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
105-
106-
latex:
107-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
108-
@echo
109-
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
110-
@echo "Run \`make' in that directory to run these through (pdf)latex" \
111-
"(use \`make latexpdf' here to do that automatically)."
112-
113-
latexpdf:
114-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
115-
@echo "Running LaTeX files through pdflatex..."
116-
$(MAKE) -C $(BUILDDIR)/latex all-pdf
117-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
118-
119-
latexpdfja:
120-
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121-
@echo "Running LaTeX files through platex and dvipdfmx..."
122-
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
123-
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124-
125-
text:
126-
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
127-
@echo
128-
@echo "Build finished. The text files are in $(BUILDDIR)/text."
129-
130-
man:
131-
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
132-
@echo
133-
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
134-
135-
texinfo:
136-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
137-
@echo
138-
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
139-
@echo "Run \`make' in that directory to run these through makeinfo" \
140-
"(use \`make info' here to do that automatically)."
141-
142-
info:
143-
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
144-
@echo "Running Texinfo files through makeinfo..."
145-
make -C $(BUILDDIR)/texinfo info
146-
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
147-
148-
gettext:
149-
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
150-
@echo
151-
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
152-
153-
changes:
154-
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
155-
@echo
156-
@echo "The overview file is in $(BUILDDIR)/changes."
157-
158-
linkcheck:
159-
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
160-
@echo
161-
@echo "Link check complete; look for any errors in the above output " \
162-
"or in $(BUILDDIR)/linkcheck/output.txt."
163-
164-
doctest:
165-
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
166-
@echo "Testing of doctests in the sources finished, look at the " \
167-
"results in $(BUILDDIR)/doctest/output.txt."
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
16814

169-
xml:
170-
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
171-
@echo
172-
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
15+
.PHONY: help Makefile
17316

174-
pseudoxml:
175-
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
176-
@echo
177-
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/conf.py

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
import os
14+
import sys
15+
sys.path.insert(0, os.path.abspath('..'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = 'pyhht'
21+
copyright = '2021, Jaidev Deshpande'
22+
author = 'Jaidev Deshpande'
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = '0.1.0'
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
# Add any Sphinx extension module names here, as strings. They can be
31+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32+
# ones.
33+
extensions = [
34+
'matplotlib.sphinxext.plot_directive',
35+
'IPython.sphinxext.ipython_directive',
36+
'IPython.sphinxext.ipython_console_highlighting',
37+
'sphinx.ext.mathjax',
38+
'sphinx.ext.autodoc',
39+
'sphinx.ext.autosummary',
40+
'sphinx.ext.doctest',
41+
'sphinx.ext.inheritance_diagram',
42+
'sphinx.ext.napoleon',
43+
'numpydoc']
44+
45+
# Add any paths that contain templates here, relative to this directory.
46+
templates_path = ['_templates']
47+
48+
# List of patterns, relative to source directory, that match files and
49+
# directories to ignore when looking for source files.
50+
# This pattern also affects html_static_path and html_extra_path.
51+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
52+
53+
54+
# -- Options for HTML output -------------------------------------------------
55+
56+
# The theme to use for HTML and HTML Help pages. See the documentation for
57+
# a list of builtin themes.
58+
#
59+
html_theme = 'alabaster'
60+
61+
# Add any paths that contain custom static files (such as style sheets) here,
62+
# relative to this directory. They are copied after the builtin static files,
63+
# so a file named "default.css" will overwrite the builtin "default.css".
64+
# html_static_path = ['_static']

‎docs/source/examples.rst ‎docs/examples.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ PyHHT Examples
33

44
* Reassigned spectrogram of a signal having sinusoidal frequency modulation
55

6-
.. plot:: ../examples/fmsin_spectrogram.py
6+
.. plot:: examples/fmsin_spectrogram.py

‎docs/source/index.rst ‎docs/index.rst

File renamed without changes.

‎docs/make.bat

+10-217
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,18 @@
11
@ECHO OFF
22

3+
pushd %~dp0
4+
35
REM Command file for Sphinx documentation
46

57
if "%SPHINXBUILD%" == "" (
68
set SPHINXBUILD=sphinx-build
79
)
8-
set BUILDDIR=build
9-
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
10-
set I18NSPHINXOPTS=%SPHINXOPTS% source
11-
if NOT "%PAPER%" == "" (
12-
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13-
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14-
)
10+
set SOURCEDIR=.
11+
set BUILDDIR=_build
1512

1613
if "%1" == "" goto help
1714

18-
if "%1" == "help" (
19-
:help
20-
echo.Please use `make ^<target^>` where ^<target^> is one of
21-
echo. html to make standalone HTML files
22-
echo. dirhtml to make HTML files named index.html in directories
23-
echo. singlehtml to make a single large HTML file
24-
echo. pickle to make pickle files
25-
echo. json to make JSON files
26-
echo. htmlhelp to make HTML files and a HTML help project
27-
echo. qthelp to make HTML files and a qthelp project
28-
echo. devhelp to make HTML files and a Devhelp project
29-
echo. epub to make an epub
30-
echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31-
echo. text to make text files
32-
echo. man to make manual pages
33-
echo. texinfo to make Texinfo files
34-
echo. gettext to make PO message catalogs
35-
echo. changes to make an overview over all changed/added/deprecated items
36-
echo. xml to make Docutils-native XML files
37-
echo. pseudoxml to make pseudoxml-XML files for display purposes
38-
echo. linkcheck to check all external links for integrity
39-
echo. doctest to run all doctests embedded in the documentation if enabled
40-
goto end
41-
)
42-
43-
if "%1" == "clean" (
44-
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
45-
del /q /s %BUILDDIR%\*
46-
goto end
47-
)
48-
49-
50-
%SPHINXBUILD% 2> nul
15+
%SPHINXBUILD% >NUL 2>NUL
5116
if errorlevel 9009 (
5217
echo.
5318
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
@@ -60,183 +25,11 @@ if errorlevel 9009 (
6025
exit /b 1
6126
)
6227

63-
if "%1" == "html" (
64-
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
65-
if errorlevel 1 exit /b 1
66-
echo.
67-
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
68-
goto end
69-
)
70-
71-
if "%1" == "dirhtml" (
72-
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
73-
if errorlevel 1 exit /b 1
74-
echo.
75-
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
76-
goto end
77-
)
78-
79-
if "%1" == "singlehtml" (
80-
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
81-
if errorlevel 1 exit /b 1
82-
echo.
83-
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
84-
goto end
85-
)
86-
87-
if "%1" == "pickle" (
88-
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
89-
if errorlevel 1 exit /b 1
90-
echo.
91-
echo.Build finished; now you can process the pickle files.
92-
goto end
93-
)
94-
95-
if "%1" == "json" (
96-
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
97-
if errorlevel 1 exit /b 1
98-
echo.
99-
echo.Build finished; now you can process the JSON files.
100-
goto end
101-
)
102-
103-
if "%1" == "htmlhelp" (
104-
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105-
if errorlevel 1 exit /b 1
106-
echo.
107-
echo.Build finished; now you can run HTML Help Workshop with the ^
108-
.hhp project file in %BUILDDIR%/htmlhelp.
109-
goto end
110-
)
111-
112-
if "%1" == "qthelp" (
113-
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114-
if errorlevel 1 exit /b 1
115-
echo.
116-
echo.Build finished; now you can run "qcollectiongenerator" with the ^
117-
.qhcp project file in %BUILDDIR%/qthelp, like this:
118-
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyhht.qhcp
119-
echo.To view the help file:
120-
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyhht.ghc
121-
goto end
122-
)
123-
124-
if "%1" == "devhelp" (
125-
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126-
if errorlevel 1 exit /b 1
127-
echo.
128-
echo.Build finished.
129-
goto end
130-
)
131-
132-
if "%1" == "epub" (
133-
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134-
if errorlevel 1 exit /b 1
135-
echo.
136-
echo.Build finished. The epub file is in %BUILDDIR%/epub.
137-
goto end
138-
)
139-
140-
if "%1" == "latex" (
141-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142-
if errorlevel 1 exit /b 1
143-
echo.
144-
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
145-
goto end
146-
)
147-
148-
if "%1" == "latexpdf" (
149-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
150-
cd %BUILDDIR%/latex
151-
make all-pdf
152-
cd %BUILDDIR%/..
153-
echo.
154-
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
155-
goto end
156-
)
157-
158-
if "%1" == "latexpdfja" (
159-
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
160-
cd %BUILDDIR%/latex
161-
make all-pdf-ja
162-
cd %BUILDDIR%/..
163-
echo.
164-
echo.Build finished; the PDF files are in %BUILDDIR%/latex.
165-
goto end
166-
)
167-
168-
if "%1" == "text" (
169-
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170-
if errorlevel 1 exit /b 1
171-
echo.
172-
echo.Build finished. The text files are in %BUILDDIR%/text.
173-
goto end
174-
)
175-
176-
if "%1" == "man" (
177-
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178-
if errorlevel 1 exit /b 1
179-
echo.
180-
echo.Build finished. The manual pages are in %BUILDDIR%/man.
181-
goto end
182-
)
183-
184-
if "%1" == "texinfo" (
185-
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186-
if errorlevel 1 exit /b 1
187-
echo.
188-
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
189-
goto end
190-
)
28+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29+
goto end
19130

192-
if "%1" == "gettext" (
193-
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194-
if errorlevel 1 exit /b 1
195-
echo.
196-
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
197-
goto end
198-
)
199-
200-
if "%1" == "changes" (
201-
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202-
if errorlevel 1 exit /b 1
203-
echo.
204-
echo.The overview file is in %BUILDDIR%/changes.
205-
goto end
206-
)
207-
208-
if "%1" == "linkcheck" (
209-
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210-
if errorlevel 1 exit /b 1
211-
echo.
212-
echo.Link check complete; look for any errors in the above output ^
213-
or in %BUILDDIR%/linkcheck/output.txt.
214-
goto end
215-
)
216-
217-
if "%1" == "doctest" (
218-
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219-
if errorlevel 1 exit /b 1
220-
echo.
221-
echo.Testing of doctests in the sources finished, look at the ^
222-
results in %BUILDDIR%/doctest/output.txt.
223-
goto end
224-
)
225-
226-
if "%1" == "xml" (
227-
%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228-
if errorlevel 1 exit /b 1
229-
echo.
230-
echo.Build finished. The XML files are in %BUILDDIR%/xml.
231-
goto end
232-
)
233-
234-
if "%1" == "pseudoxml" (
235-
%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236-
if errorlevel 1 exit /b 1
237-
echo.
238-
echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
239-
goto end
240-
)
31+
:help
32+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
24133

24234
:end
35+
popd

‎docs/source/apiref/modules.rst

-7
This file was deleted.

‎docs/source/apiref/pyhht.rst

-38
This file was deleted.

‎docs/source/conf.py

-283
This file was deleted.

‎docs/source/tutorials.rst ‎docs/tutorials.rst

File renamed without changes.

‎docs/source/tutorials/intro_pyhht.rst ‎docs/tutorials/intro_pyhht.rst

File renamed without changes.

‎docs/source/tutorials/plots/intro_1.py ‎docs/tutorials/plots/intro_1.py

File renamed without changes.

‎docs/source/tutorials/plots/intro_2.py ‎docs/tutorials/plots/intro_2.py

File renamed without changes.

‎docs/source/tutorials/plots/intro_fmsin.py ‎docs/tutorials/plots/intro_fmsin.py

File renamed without changes.

‎pyhht/emd.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ def __init__(self, x, t=None, threshold_1=0.05, threshold_2=0.5,
105105
>>> imfs = decomposer.decompose()
106106
>>> plot_imfs(x, imfs, t) #doctest: +SKIP
107107
108-
.. plot:: ../../docs/examples/simple_emd.py
108+
.. plot:: examples/simple_emd.py
109109
110110
"""
111111

‎pyhht/visualization.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def plot_imfs(signal, imfs, time_samples=None, fignum=None, show=True):
4949
>>> imfs = decomposer.decompose()
5050
>>> plot_imfs(x, imfs, t) #doctest: +SKIP
5151
52-
.. plot:: ../../docs/examples/simple_emd.py
52+
.. plot:: examples/simple_emd.py
5353
5454
"""
5555
is_bivariate = np.any(np.iscomplex(signal))

‎requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@ coveralls
77
nose
88
six
99
# examples
10-
-e git+http://github.com/scikit-signal/pytftb#egg=pytftb
10+
tftb==0.1.3
1111
# readthedocs
1212
numpydoc

0 commit comments

Comments
 (0)
Please sign in to comment.