Doc-related issues

[jbschiratti]

Since the last PR, there are warnings when building the doc of MNE-features.

WARNING: [autosummary] failed to import u'mne_features.univariate.compute_spect_edge': no module named mne_features.univariate.compute_spect_edge

It seems that Travis is not checking the doc carefully enough.
Maybe, we should ask Travis to do something like:

sphinx-build -nW -b html -d _build/doctrees . _build/html

so that the build actually fails if warnings are triggered by Sphinx.

[agramfort]

Did you make clean before ?

[jbschiratti]

Yes, I do make cleaneach time I build the doc.

[jbschiratti]

I might have updated Sphinx (or sphinx-gallery) without being fully aware of it... Anyway, now I'm using Sphinx 1.6.6 and sphinx-gallery 0.1.13. When I build the doc of MNE-features, I get the following warnings... @agramfort, I think you had these warnings before, right?

<autosummary>:1: WARNING: citation not found: Rash0402
<autosummary>:1: WARNING: citation not found: Deva1402
<autosummary>:1: WARNING: citation not found: Rich0045
<autosummary>:1: WARNING: citation not found: Rich00
<autosummary>:1: WARNING: citation not found: Teix1167
<autosummary>:1: WARNING: citation not found: Teix11
<autosummary>:1: WARNING: citation not found: Morm0689
<autosummary>:1: WARNING: citation not found: Teix11
<autosummary>:1: WARNING: citation not found: Morm06
<autosummary>:1: WARNING: citation not found: Teix11
<autosummary>:1: WARNING: citation not found: Paiv051011
<autosummary>:1: WARNING: citation not found: Paiv05
<autosummary>:1: WARNING: citation not found: Este01a1213
<autosummary>:1: WARNING: citation not found: Paiv05
<autosummary>:1: WARNING: citation not found: Este01a
<autosummary>:1: WARNING: citation not found: Este01b1415
<autosummary>:1: WARNING: citation not found: Inou911617
<autosummary>:1: WARNING: citation not found: Robe991819
<autosummary>:1: WARNING: citation not found: Robe99
<autosummary>:1: WARNING: citation not found: Khar112021
<autosummary>:1: WARNING: citation not found: Morm06
<autosummary>:1: WARNING: citation not found: Teix11
<autosummary>:1: WARNING: citation not found: Bada172223
<autosummary>:1: WARNING: citation not found: Morm06
<autosummary>:1: WARNING: citation not found: Miro082425
<autosummary>:1: WARNING: citation not found: Plv2627
<autosummary>:1: WARNING: citation not found: Morm06
<autosummary>:1: WARNING: citation not found: Miro08
<autosummary>:1: WARNING: citation not found: Tisp2829
<autosummary>:1: WARNING: citation not found: Tisp
/cal/homes/jbschiratti/mne-features/mne_features/bivariate.py:docstring of mne_features.bivariate.compute_max_cross_corr:2: WARNING: citation not found: Morm06
/cal/homes/jbschiratti/mne-features/mne_features/bivariate.py:docstring of mne_features.bivariate.compute_nonlin_interdep:2: WARNING: citation not found: Morm06
/cal/homes/jbschiratti/mne-features/mne_features/bivariate.py:docstring of mne_features.bivariate.compute_nonlin_interdep:2: WARNING: citation not found: Miro08
/cal/homes/jbschiratti/mne-features/mne_features/bivariate.py:docstring of mne_features.bivariate.compute_spect_corr:2: WARNING: citation not found: Tisp
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_higuchi_fd:2: WARNING: citation not found: Paiv05
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_hjorth_complexity:2: WARNING: citation not found: Paiv05
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_hjorth_complexity_spect:2: WARNING: citation not found: Morm06
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_hjorth_complexity_spect:2: WARNING: citation not found: Teix11
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_hjorth_mobility_spect:2: WARNING: citation not found: Teix11
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_hjorth_mobility_spect:19: WARNING: citation not found: Teix11
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_katz_fd:2: WARNING: citation not found: Este01a
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_pow_freq_bands:2: WARNING: citation not found: Teix11
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_samp_entropy:2: WARNING: citation not found: Rich00
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_spect_edge_freq:2: WARNING: citation not found: Morm06
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_svd_fisher_info:2: WARNING: citation not found: Robe99
/cal/homes/jbschiratti/mne-features/mne_features/univariate.py:docstring of mne_features.univariate.compute_wavelet_coef_energy:2: WARNING: citation not found: Teix11

These warnings come from internal references of the form [ref]_. When [ref] is already defined somewhere (in a References section) in the module, [ref]_ would create a link to the reference without having to duplicate its definition. So, let's keep it simple and duplicate references or is there a workaround I don't know?

[agramfort]

yes I would duplicate the refs. It's the same errors I have