Skip to content

Commit

Permalink
MRG: Use numpydoc from pip (mne-tools#3337)
Browse files Browse the repository at this point in the history
* ENH: Use numpydoc from pip

* DOC: Explain nesting [ci skip]

* FIX: Fix typos
  • Loading branch information
larsoner authored and agramfort committed Jun 26, 2016
1 parent a361dce commit cd0300a
Show file tree
Hide file tree
Showing 16 changed files with 277 additions and 1,149 deletions.
2 changes: 1 addition & 1 deletion circle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ dependencies:
- git clone https://github.com/sphinx-gallery/sphinx-gallery.git;
- cd sphinx-gallery && pip install -r requirements.txt && python setup.py develop;
- cd /home/ubuntu && git clone https://github.com/enthought/pyface.git && cd pyface && python setup.py develop;
- pip install sphinx_bootstrap_theme PySurfer nilearn neo;
- pip install sphinx_bootstrap_theme PySurfer nilearn neo numpydoc;

override:
- cd /home/ubuntu/mne-python && python setup.py develop;
Expand Down
10 changes: 8 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
sys.path.append(os.path.abspath(os.path.join(curdir, 'sphinxext')))

import mne
if not os.path.isdir('_images'):
os.mkdir('_images')

# -- General configuration ------------------------------------------------

Expand All @@ -34,7 +36,9 @@

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
import numpy_ext.numpydoc
from numpydoc import numpydoc, docscrape
docscrape.ClassDoc.extra_public_methods = mne.utils._doc_special_members

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
Expand All @@ -46,7 +50,7 @@
'sphinx_gallery.gen_gallery',
]

extensions += ['numpy_ext.numpydoc']
extensions += ['numpydoc']
extensions += ['gen_commands'] # auto generate the doc for the python commands
# extensions += ['flow_diagram] # generate flow chart in cookbook

Expand Down Expand Up @@ -296,3 +300,5 @@
'default_thumb_file': os.path.join('_static', 'mne_helmet.png'),
'mod_example_dir': 'generated',
}

numpydoc_class_members_toctree = False
Loading

0 comments on commit cd0300a

Please sign in to comment.