From 8c2ea7078d56b459918782785a45107a10dbf812 Mon Sep 17 00:00:00 2001 From: Kazuhiro KOBAYASHI Date: Fri, 29 Sep 2017 14:34:42 +0900 Subject: [PATCH 1/2] modify docstring in sprocket --- sprocket/model/GMM.py | 30 ++++++++++++++-------------- sprocket/model/f0statistics.py | 13 ++++++------ sprocket/model/gv.py | 14 ++++++------- sprocket/speech/analyzer.py | 10 +++++----- sprocket/speech/feature_extractor.py | 6 +++--- sprocket/speech/parameterizer.py | 8 ++++---- sprocket/speech/shifter.py | 8 ++++---- sprocket/speech/synthesizer.py | 26 ++++++++++++------------ sprocket/speech/wsola.py | 6 +++--- sprocket/util/delta.py | 8 ++++---- sprocket/util/extfrm.py | 6 +++--- sprocket/util/hdf5.py | 16 +++++++++------ sprocket/util/twf.py | 4 ++-- 13 files changed, 80 insertions(+), 75 deletions(-) diff --git a/sprocket/model/GMM.py b/sprocket/model/GMM.py index b11134a..fe2502a 100644 --- a/sprocket/model/GMM.py +++ b/sprocket/model/GMM.py @@ -16,7 +16,7 @@ class GMMTrainer(object): This class offers the training of GMM with several types of covariance matrix. Parameters - --------- + ---------- n_mix: int, optional The number of mixture components of the GMM Default set to 32. @@ -29,7 +29,7 @@ class GMMTrainer(object): block_diag (not implemeted) : block-diagonal matrix Attributes - --------- + ---------- param : Sklean-based model parameters of the GMM @@ -53,7 +53,7 @@ def train(self, jnt): """Fit GMM parameter from given joint feature vector Parameters - --------- + ---------- jnt : array, shape(`T`, `jnt.shape[0]`) Joint feature vector of original and target feature vector consisting of static and delta components @@ -81,7 +81,7 @@ def train_singlepath(self, reference_jnt, jnt): EM-algorithm is performed only one time. Parameters - --------- + ---------- reference_jnt: array, shape(`T`, `reference_jnt.shape[0]`) Reference joint feature vector of original and target feature vector consisting of static and delta components, which was already fit. @@ -110,7 +110,7 @@ class GMMConvertor(object): Parameter Generation (MLPG) and Mimimum Mean Square Error (MMSE). Parameters - --------- + ---------- n_mix : int, optional The number of mixture components of the GMM Default set to 32. @@ -125,14 +125,14 @@ class GMMConvertor(object): `intra` : Intra-speaker GMM Attributes - --------- - param : + ---------- + param Sklean-based model parameters of the GMM - w : shape (`n_mix`) + w : array_like, shape (`n_mix`), Vector of mixture component weight of the GMM - jmean : shape (`n_mix`, `jnt.shape[0]`) + jmean : array_like, shape (`n_mix`, `jnt.shape[0]`), Array of joint mean vector of the GMM - jcov: shape (`n_mix`, `jnt.shape[0]`, `jnt.shape[0]`) + jcov : array, shape (`n_mix`, `jnt.shape[0]`, `jnt.shape[0]`), Array of joint covariance matrix of the GMM """ @@ -146,8 +146,8 @@ def open_from_param(self, param): """Open GMM from GMMTrainer Parameters - --------- - trainer: GMMTrainer + ---------- + trainer : GMMTrainer GMMTrainer class """ @@ -161,16 +161,16 @@ def convert(self, data, cvtype='mlpg'): """Convert data based on conditional probability densify function Parameters - --------- + ---------- data : array, shape(`T`, `dim`) Original data will be converted - cvtype: str, optional + cvtype : str, optional Type of conversion technique `mlpg` : maximum likelihood parameter generation `mmse` : minimum mean square error Returns - --------- + ------- odata : array, shape(`T`, `dim`) Converted data diff --git a/sprocket/model/f0statistics.py b/sprocket/model/f0statistics.py index 295f4d3..91cb04e 100644 --- a/sprocket/model/f0statistics.py +++ b/sprocket/model/f0statistics.py @@ -7,6 +7,7 @@ class F0statistics(object): """F0 statistics class + Estimate F0 statistics and convert F0 """ @@ -18,12 +19,12 @@ def estimate(self, f0list): """Estimate F0 statistics from list of f0 Parameters - --------- + ---------- f0list : list, shape('f0num') List of several F0 sequence Returns - --------- + ------- f0stats : array, shape(`[mean, std]`) Values of mean and standard deviation for logarithmic F0 @@ -45,16 +46,16 @@ def convert(self, f0, orgf0stats, tarf0stats): """Convert F0 based on F0 statistics Parameters - --------- + ---------- f0 : array, shape(`T`, `1`) Array of F0 sequence - orgf0stats, shape (`[mean, std]`) + orgf0stats : shape(`[mean, std]`) Vector of mean and standard deviation of logarithmic F0 for original speaker - tarf0stats, shape (`[mean, std]`) + tarf0stats : , shape(`[mean, std]`) Vector of mean and standard deviation of logarithmic F0 for target speaker Returns - --------- + ------- cvf0 : array, shape(`T`, `1`) Array of converted F0 sequence diff --git a/sprocket/model/gv.py b/sprocket/model/gv.py index dbbfe93..7ae8975 100644 --- a/sprocket/model/gv.py +++ b/sprocket/model/gv.py @@ -7,9 +7,9 @@ class GV (object): """A global variance (GV) statistics class + Estimate statistics and perform postfilter based on the GV statistics - """ def __init__(self): @@ -19,13 +19,13 @@ def estimate(self, datalist): """Estimate GV statistics from list of data Parameters - --------- + ---------- datalist : list, shape ('num_data') List of several data ([T, dim]) sequence Returns --------- - gvstats : array, shape (`2`, `dim`) + gvstats : array_like, shape (`2`, `dim`) Array of mean and standard deviation for GV """ @@ -48,12 +48,12 @@ def postfilter(self, data, gvstats, cvgvstats=None, alpha=1.0, startdim=1): """Perform postfilter based on GV statistics into data Parameters - --------- + ---------- data : array, shape (`T`, `dim`) Array of data sequence - gvstats: array, shape (`2`, `dim`) + gvstats : array, shape (`2`, `dim`) Array of mean and variance for target GV - cvgvstats: array, shape (`2`, `dim`), optional + cvgvstats : array, shape (`2`, `dim`), optional Array of mean and variance for converted GV This option replaces the mean variance of the given data into the mean variance estimated from training data. @@ -65,7 +65,7 @@ def postfilter(self, data, gvstats, cvgvstats=None, alpha=1.0, startdim=1): Start dimension to perform GV postfilter Returns - --------- + ------- filtered_data : array, shape (`T`, `data`) Array of GV postfiltered data sequence diff --git a/sprocket/speech/analyzer.py b/sprocket/speech/analyzer.py index 66874fa..5b1c0e2 100644 --- a/sprocket/speech/analyzer.py +++ b/sprocket/speech/analyzer.py @@ -45,12 +45,12 @@ def analyze(self, x): monoral speech signal in time domain Returns - --------- + ------- f0 : array, shape (`T`,) F0 sequence spc : array, shape (`T`, `fftl / 2 + 1`) Spectral envelope sequence - ap: array, shape (`T`, `fftl / 2 + 1`) + ap : array, shape (`T`, `fftl / 2 + 1`) aperiodicity sequence """ @@ -68,11 +68,11 @@ def analyze_f0(self, x): Paramters --------- - x: array, shape (`T`) + x : array, shape (`T`) monoral speech signal in time domain Returns - --------- + ------- f0 : array, shape (`T`,) F0 sequence @@ -92,7 +92,7 @@ def synthesis(self, f0, spc, ap): F0 sequence spc : array, shape (`T`, `dim`) Spectral envelope sequence - ap: array, shape (`T`, `dim`) + ap : array, shape (`T`, `dim`) Aperiodicity sequence """ diff --git a/sprocket/speech/feature_extractor.py b/sprocket/speech/feature_extractor.py index a9e320d..235a45e 100644 --- a/sprocket/speech/feature_extractor.py +++ b/sprocket/speech/feature_extractor.py @@ -26,7 +26,7 @@ class FeatureExtractor(object): fs : int, optional Sampling frequency of the waveform Default set to 16000 - fftl: int, optional + fftl : int, optional FFT length Default set to 1024 shiftms : int, optional @@ -80,7 +80,7 @@ def analyze(self, x): F0 sequence spc : array, shape (`T`, `fftl / 2 + 1`) Spectral envelope sequence - ap: array, shape (`T`, `fftl / 2 + 1`) + ap : array, shape (`T`, `fftl / 2 + 1`) aperiodicity sequence """ @@ -163,7 +163,7 @@ def npow(self): Returns ------- - npow: vector, shape (`T`,) + npow : vector, shape (`T`,) Normalized power sequence of the given waveform """ diff --git a/sprocket/speech/parameterizer.py b/sprocket/speech/parameterizer.py index ec077db..ea79d3c 100644 --- a/sprocket/speech/parameterizer.py +++ b/sprocket/speech/parameterizer.py @@ -13,8 +13,8 @@ def spc2npow(spectrogram): spectrogram : array, shape (T, `fftlen / 2 + 1`) Array of specturm envelope - Return - ------ + Returns + ------- npow : array, shape (`T`, `1`) Normalized power sequence @@ -37,8 +37,8 @@ def _spvec2pow(specvec): specvec : vector, shape (`fftlen / 2 + 1`) Cector of specturm envelope - Return - ------ + Returns + ------- power : scala, Normalized power diff --git a/sprocket/speech/shifter.py b/sprocket/speech/shifter.py index 8b6ec46..bef4dac 100644 --- a/sprocket/speech/shifter.py +++ b/sprocket/speech/shifter.py @@ -20,7 +20,7 @@ class Shifter(object): ---------- fs : int Sampling frequency - f0rate: float + f0rate : float F0 transformation ratio shift_ms : int, optional length of shift size [ms] @@ -54,7 +54,7 @@ def f0transform(self, x, completion=False): when F0ratio setting to smaller than 1.0. Returns - --------- + ------- transformed : array, shape (`len(x)`) Array of F0 transformed waveform sequence @@ -80,12 +80,12 @@ def resampling_by_interpolate(self, x): """Resampling base on 1st order interpolation Parameters - --------- + ---------- x : array, shape ('int(len(x) * f0rate)') array of wsolaed waveform Returns - --------- + ------- wsolaed: array, shape (`len(x)`) Array of resampled (F0 transformed) waveform sequence diff --git a/sprocket/speech/synthesizer.py b/sprocket/speech/synthesizer.py index e0cdd80..a08c6dd 100644 --- a/sprocket/speech/synthesizer.py +++ b/sprocket/speech/synthesizer.py @@ -14,13 +14,13 @@ class Synthesizer(object): Parameters ---------- - fs: int, optional + fs : int, optional Sampling frequency Default set to 16000 - fftl: int, optional + fftl : int, optional Frame Length of STFT Default set to 1024 - shiftms: int, optional + shiftms : int, optional Shift size for STFT Default set to 5 """ @@ -51,8 +51,8 @@ def synthesis(self, f0, mcep, ap, rmcep=None, alpha=0.42): Default set to 0.42 Returns - ---------- - wav: array, + ------- + wav : array, Synethesized waveform """ @@ -86,9 +86,9 @@ def synthesis_diff(self, x, diffmcep, rmcep=None, alpha=0.42): Parameter of all-path transfer function Default set to 0.42 - Return - ---------- - wav: array, shape (`samples`) + Returns + ------- + wav : array, shape (`samples`) Synethesized waveform """ @@ -122,9 +122,9 @@ def synthesis_spc(self, f0, spc, ap): ap : array, shape (`T`, `fftl // 2 + 1`) array of aperiodicity - Return - ------ - wav: vector, shape (`samples`) + Returns + ------- + wav : vector, shape (`samples`) Synethesized waveform """ @@ -152,8 +152,8 @@ def mod_power(cvmcep, rmcep, alpha=0.42, irlen=256): Length for IIR filter Default set to 256 - Return - ------ + Returns + ------- modified_cvmcep : array, shape (`T`, `dim`) array of power modified converted mel-cepstrum diff --git a/sprocket/speech/wsola.py b/sprocket/speech/wsola.py index 0d6e77c..78f7575 100644 --- a/sprocket/speech/wsola.py +++ b/sprocket/speech/wsola.py @@ -42,13 +42,13 @@ def duration_modification(self, x): """Duration modification based on WSOLA Parameters - --------- + ---------- x : array, shape ('len(x)') array of waveform sequence Returns - --------- - wsolaed: array, shape (`int(len(x) / speech_rate)`) + ------- + wsolaed : array, shape (`int(len(x) / speech_rate)`) Array of WSOLAed waveform sequence """ diff --git a/sprocket/util/delta.py b/sprocket/util/delta.py index b64c641..2701da9 100644 --- a/sprocket/util/delta.py +++ b/sprocket/util/delta.py @@ -13,7 +13,7 @@ def delta(data, win=[-1.0, 1.0, 0]): ---------- data : array, shape (`T`, `dim`) Array of static matrix sequence. - win: array, optional, shape (`3`) + win : array, optional, shape (`3`) The shape of window matrix. Default set to [-1.0, 1.0, 0]. @@ -51,13 +51,13 @@ def static_delta(data, win=[-1.0, 1.0, 0]): ---------- data : array, shape (`T`, `dim`) Array of static matrix sequence. - win: array, optional, shape (`3`) + win : array, optional, shape (`3`) The shape of window matrix. Default set to [-1.0, 1.0, 0]. Returns ------- - sddata: array, shape (`T`, `dim*2`) + sddata : array, shape (`T`, `dim*2`) Array static and delta matrix sequence. """ @@ -75,7 +75,7 @@ def construct_static_and_delta_matrix(T, D, win=[-1.0, 1.0, 0]): Scala of time length D : scala, `D` Scala of the number of dimentsion - win: array, optional, shape (`3`) + win : array, optional, shape (`3`) The shape of window matrix for delta. Default set to [-1.0, 1.0, 0]. diff --git a/sprocket/util/extfrm.py b/sprocket/util/extfrm.py index 1e3748f..5778af7 100644 --- a/sprocket/util/extfrm.py +++ b/sprocket/util/extfrm.py @@ -10,17 +10,17 @@ def extfrm(data, npow, threshold=-20): Parameters ---------- - data: array, shape (`T`, `dim`) + data : array, shape (`T`, `dim`) Array of input data npow : array, shape (`T`) Vector of normalized power sequence. - threshold: scala, optional + threshold : int, optional Scala of power threshold [dB] Default set to -20 Returns ------- - data: array, shape (`T_ext`, `dim`) + data : array, shape (`T_ext`, `dim`) Remaining data after extracting frame `T_ext` <= `T` diff --git a/sprocket/util/hdf5.py b/sprocket/util/hdf5.py index 7eedcfa..124b1e9 100644 --- a/sprocket/util/hdf5.py +++ b/sprocket/util/hdf5.py @@ -11,7 +11,7 @@ class HDF5(object): Offer the hdf5 format file handler Parameters - --------- + ---------- fpath : str, Path of hdf5 file @@ -21,7 +21,7 @@ class HDF5(object): `r` : open as read Attributes - --------- + ---------- h5 : hdf5 class """ @@ -55,7 +55,7 @@ def read(self, ext=None): """Read vector or array from h5 file Parameters - --------- + ---------- ext : str File extention including h5 file @@ -77,11 +77,11 @@ def save(self, data, ext=None): """Write vector or array into h5 file Parameters - --------- - data : + ---------- + data : array_like Vector or array will be wrote into h5 file - ext: str + ext : str File label of saved file """ @@ -97,6 +97,10 @@ def save(self, data, ext=None): return def close(self): + """Close HDF5 Class + + """ + self.h5.close() return diff --git a/sprocket/util/twf.py b/sprocket/util/twf.py index 8fb4f2b..876ced2 100644 --- a/sprocket/util/twf.py +++ b/sprocket/util/twf.py @@ -13,7 +13,7 @@ def estimate_twf(orgdata, tardata, distance='melcd', fast=True): """time warping function estimator Parameters - --------- + ---------- orgdata : array, shape(`T_org`, `dim`) Array of source feature tardata : array, shape(`T_tar`, `dim`) @@ -26,7 +26,7 @@ def estimate_twf(orgdata, tardata, distance='melcd', fast=True): Default set to `True` Returns - --------- + ------- twf : array, shape(`2`, `T`) Time warping function between original and target """ From 39afd29fec165be6dde5a3ef77831961fdfef50e Mon Sep 17 00:00:00 2001 From: Kazuhiro KOBAYASHI Date: Fri, 29 Sep 2017 14:36:29 +0900 Subject: [PATCH 2/2] created docs generated by sphinx and its make scripts --- .gitignore | 1 - docs/Makefile | 20 ++ docs/make.bat | 36 ++++ docs/make.csh | 3 + docs/source/Makefile | 241 ++++++++++++++++++++++ docs/source/conf.py | 199 +++++++++++++++++++ docs/source/index.rst | 20 ++ docs/source/make.bat | 275 ++++++++++++++++++++++++++ docs/source/modules.rst | 7 + docs/source/sprocket.model.rst | 38 ++++ docs/source/sprocket.rst | 19 ++ docs/source/sprocket.speech.rst | 69 +++++++ docs/source/sprocket.speech.tests.rst | 46 +++++ docs/source/sprocket.util.rst | 61 ++++++ docs/source/sprocket.util.tests.rst | 38 ++++ 15 files changed, 1072 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100755 docs/make.csh create mode 100644 docs/source/Makefile create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/make.bat create mode 100644 docs/source/modules.rst create mode 100644 docs/source/sprocket.model.rst create mode 100644 docs/source/sprocket.rst create mode 100644 docs/source/sprocket.speech.rst create mode 100644 docs/source/sprocket.speech.tests.rst create mode 100644 docs/source/sprocket.util.rst create mode 100644 docs/source/sprocket.util.tests.rst diff --git a/.gitignore b/.gitignore index 6d52544..1a15e83 100644 --- a/.gitignore +++ b/.gitignore @@ -187,7 +187,6 @@ target/ ### CMake ### CMakeCache.txt CMakeFiles -Makefile cmake_install.cmake install_manifest.txt diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..cc1afcf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python -msphinx +SPHINXPROJ = sprocket +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..ae362a8 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=sprocket + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/make.csh b/docs/make.csh new file mode 100755 index 0000000..0f222d3 --- /dev/null +++ b/docs/make.csh @@ -0,0 +1,3 @@ +#!/bin/csh +sphinx-apidoc -f -o ./source ../sprocket +make html diff --git a/docs/source/Makefile b/docs/source/Makefile new file mode 100644 index 0000000..2d8e6c9 --- /dev/null +++ b/docs/source/Makefile @@ -0,0 +1,241 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = python -msphinx +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_elements.papersize=a4 +PAPEROPT_letter = -D latex_elements.papersize=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and an HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " epub3 to make an epub3" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " lualatexpdf to make LaTeX files and run them through lualatex" + @echo " xelatexpdf to make LaTeX files and run them through xelatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + @echo " dummy to check syntax errors of document sources" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sprocket.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sprocket.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/sprocket" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sprocket" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: epub3 +epub3: + $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 + @echo + @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: lualatexpdf +lualatexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through lualatex..." + $(MAKE) PDFLATEX=lualatex -C $(BUILDDIR)/latex all-pdf + @echo "lualatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: xelatexpdf +xelatexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through xelatex..." + $(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf + @echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +.PHONY: dummy +dummy: + $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy + @echo + @echo "Build finished. Dummy builder generates no files." diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..4bebb31 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,199 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# sprocket documentation build configuration file, created by +# sphinx-quickstart on Fri Sep 29 12:07:29 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# 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. +# +import os +import sys +import sphinx_rtd_theme +from recommonmark.parser import CommonMarkParser +from recommonmark.transform import AutoStructify + +sys.path.insert(0, os.path.abspath('../../sprocket')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.coverage', + 'sphinx.ext.mathjax', + 'sphinx.ext.ifconfig', + 'sphinx.ext.viewcode', + 'sphinx.ext.githubpages', + 'numpydoc' + ] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +source_suffix = ['.rst', '.md'] + +source_parsers = { + '.md': CommonMarkParser, +} + +github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/' + + +def setup(app): + app.add_config_value('recommonmark_config', { + 'url_resolver': lambda url: github_doc_root + url, + 'auto_toc_tree_section': 'Contents', + }, True) + app.add_transform(AutoStructify) + + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'sprocket' +copyright = '2017, Kazuhiro Kobayashi' +author = 'Kazuhiro Kobayashi' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.2.4' +# The full version, including alpha/beta/rc tags. +release = '0.2.4' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# 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'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + 'donate.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'sprocketdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'sprocket.tex', 'sprocket Documentation', + 'Kazuhiro Kobayashi', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'sprocket', 'sprocket Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'sprocket', 'sprocket Documentation', + author, 'sprocket', 'One line description of project.', + 'Miscellaneous'), +] + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..62f294b --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. sprocket documentation master file, created by + sphinx-quickstart on Fri Sep 29 12:07:29 2017. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to sprocket's documentation! +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/make.bat b/docs/source/make.bat new file mode 100644 index 0000000..c1ac87f --- /dev/null +++ b/docs/source/make.bat @@ -0,0 +1,275 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +pushd %~dp0 + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=python -msphinx +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_elements.papersize=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_elements.papersize=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and an HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. epub3 to make an epub3 + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + echo. dummy to check syntax errors of document sources + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available +%SPHINXBUILD% 1>NUL 2>NUL +if errorlevel 1 ( + echo. + echo.The Sphinx module was not found. Make sure you have Sphinx installed, + echo.then set the SPHINXBUILD environment variable to point to the full + echo.path of the 'sphinx-build' executable. Alternatively you may add the + echo.Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\sprocket.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\sprocket.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "epub3" ( + %SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3 + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub3 file is in %BUILDDIR%/epub3. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +if "%1" == "dummy" ( + %SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. Dummy builder generates no files. + goto end +) + +:end +popd diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..cd141c4 --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +sprocket +======== + +.. toctree:: + :maxdepth: 4 + + sprocket diff --git a/docs/source/sprocket.model.rst b/docs/source/sprocket.model.rst new file mode 100644 index 0000000..2e32c55 --- /dev/null +++ b/docs/source/sprocket.model.rst @@ -0,0 +1,38 @@ +sprocket\.model package +======================= + +Submodules +---------- + +sprocket\.model\.GMM module +--------------------------- + +.. automodule:: sprocket.model.GMM + :members: + :undoc-members: + :show-inheritance: + +sprocket\.model\.f0statistics module +------------------------------------ + +.. automodule:: sprocket.model.f0statistics + :members: + :undoc-members: + :show-inheritance: + +sprocket\.model\.gv module +-------------------------- + +.. automodule:: sprocket.model.gv + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sprocket.model + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sprocket.rst b/docs/source/sprocket.rst new file mode 100644 index 0000000..009ad84 --- /dev/null +++ b/docs/source/sprocket.rst @@ -0,0 +1,19 @@ +sprocket package +================ + +Subpackages +----------- + +.. toctree:: + + sprocket.model + sprocket.speech + sprocket.util + +Module contents +--------------- + +.. automodule:: sprocket + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sprocket.speech.rst b/docs/source/sprocket.speech.rst new file mode 100644 index 0000000..93e9aba --- /dev/null +++ b/docs/source/sprocket.speech.rst @@ -0,0 +1,69 @@ +sprocket\.speech package +======================== + +Subpackages +----------- + +.. toctree:: + + sprocket.speech.tests + +Submodules +---------- + +sprocket\.speech\.analyzer module +--------------------------------- + +.. automodule:: sprocket.speech.analyzer + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.feature\_extractor module +------------------------------------------- + +.. automodule:: sprocket.speech.feature_extractor + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.parameterizer module +-------------------------------------- + +.. automodule:: sprocket.speech.parameterizer + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.shifter module +-------------------------------- + +.. automodule:: sprocket.speech.shifter + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.synthesizer module +------------------------------------ + +.. automodule:: sprocket.speech.synthesizer + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.wsola module +------------------------------ + +.. automodule:: sprocket.speech.wsola + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sprocket.speech + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sprocket.speech.tests.rst b/docs/source/sprocket.speech.tests.rst new file mode 100644 index 0000000..f3916c8 --- /dev/null +++ b/docs/source/sprocket.speech.tests.rst @@ -0,0 +1,46 @@ +sprocket\.speech\.tests package +=============================== + +Submodules +---------- + +sprocket\.speech\.tests\.test\_acousticfeature module +----------------------------------------------------- + +.. automodule:: sprocket.speech.tests.test_acousticfeature + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.tests\.test\_modpower module +---------------------------------------------- + +.. automodule:: sprocket.speech.tests.test_modpower + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.tests\.test\_shifter module +--------------------------------------------- + +.. automodule:: sprocket.speech.tests.test_shifter + :members: + :undoc-members: + :show-inheritance: + +sprocket\.speech\.tests\.test\_wsola module +------------------------------------------- + +.. automodule:: sprocket.speech.tests.test_wsola + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sprocket.speech.tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sprocket.util.rst b/docs/source/sprocket.util.rst new file mode 100644 index 0000000..7563593 --- /dev/null +++ b/docs/source/sprocket.util.rst @@ -0,0 +1,61 @@ +sprocket\.util package +====================== + +Subpackages +----------- + +.. toctree:: + + sprocket.util.tests + +Submodules +---------- + +sprocket\.util\.delta module +---------------------------- + +.. automodule:: sprocket.util.delta + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.distance module +------------------------------- + +.. automodule:: sprocket.util.distance + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.extfrm module +----------------------------- + +.. automodule:: sprocket.util.extfrm + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.hdf5 module +--------------------------- + +.. automodule:: sprocket.util.hdf5 + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.twf module +-------------------------- + +.. automodule:: sprocket.util.twf + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sprocket.util + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/sprocket.util.tests.rst b/docs/source/sprocket.util.tests.rst new file mode 100644 index 0000000..08d37ef --- /dev/null +++ b/docs/source/sprocket.util.tests.rst @@ -0,0 +1,38 @@ +sprocket\.util\.tests package +============================= + +Submodules +---------- + +sprocket\.util\.tests\.test\_delta module +----------------------------------------- + +.. automodule:: sprocket.util.tests.test_delta + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.tests\.test\_hdf5 module +---------------------------------------- + +.. automodule:: sprocket.util.tests.test_hdf5 + :members: + :undoc-members: + :show-inheritance: + +sprocket\.util\.tests\.test\_melcd module +----------------------------------------- + +.. automodule:: sprocket.util.tests.test_melcd + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: sprocket.util.tests + :members: + :undoc-members: + :show-inheritance: