DOC: Switch to napoleon instead of numpydoc.

matplotlib · QuLogic · Dec 24, 2015 · Dec 24, 2015 · Dec 24, 2015 · Dec 24, 2015
commit c7042adb736d7eab64f589424256c2d29e4aa37c
diff --git a/.travis.yml b/.travis.yml
@@ -100,7 +100,7 @@ install:
  # Neihter is installed as a dependency of IPython since they are not used by the IPython console.
  - |
    if [[ $BUILD_DOCS == true ]]; then
-      pip install $PRE numpydoc ipython jsonschema mistune colorspacious
+      pip install $PRE ipython jsonschema mistune colorspacious
      pip install -q $PRE linkchecker
      wget https://github.com/google/fonts/blob/master/ofl/felipa/Felipa-Regular.ttf?raw=true -O Felipa-Regular.ttf
      wget http://mirrors.kernel.org/ubuntu/pool/universe/f/fonts-humor-sans/fonts-humor-sans_1.0-1_all.deb

diff --git a/doc/README.txt b/doc/README.txt
@@ -33,11 +33,10 @@ python documentation system built on top of ReST.  This directory contains
 * mpl_examples - a link to the matplotlib examples in case any
  documentation wants to literal include them

-To build the HTML documentation, install sphinx (1.0 or greater
-required), then type "python make.py html" in this directory.  Wait
-for the initial run (which builds the example gallery) to be done,
-then run "python make.py html" again. The top file of the results will
-be ./build/html/index.html
+To build the HTML documentation, install sphinx (1.0 or greater required) and,
+if sphinx older than 1.3, sphinxcontrib-napoleon, then type "python make.py
+html" in this directory.  The top file of the results will be
+./build/html/index.html

 Note that Sphinx uses the installed version of the package to build
 the documentation, so matplotlib must be installed *before* the docs

diff --git a/doc/conf.py b/doc/conf.py
@@ -32,7 +32,11 @@
              'sphinx.ext.inheritance_diagram',
              'sphinxext.gen_gallery', 'sphinxext.gen_rst',
              'sphinxext.github',
-              'numpydoc']
+             ]
+if hasattr(sphinx, 'version_info') and sphinx.version_info[:2] >= (1, 3):
+    extensions += ['sphinx.ext.napoleon']
+else:
+    extensions += ['sphinxcontrib.napoleon']

 exclude_patterns = ['api/api_changes/*', 'users/whats_new/*']

@@ -46,12 +50,6 @@
    extensions.append('IPython.sphinxext.ipython_console_highlighting')
    extensions.append('IPython.sphinxext.ipython_directive')

-try:
-    import numpydoc
-except ImportError:
-    raise ImportError("No module named numpydoc - you need to install "
-                      "numpydoc to build the documentation.")
-

 autosummary_generate = True

@@ -333,5 +331,6 @@ def getapi(*args):
 sys.modules['sip'] = mocksip
 sys.modules['PyQt4'] = mockpyqt4

-################# numpydoc config ####################
-numpydoc_show_class_members = False
+################# napoleon config ####################
+napoleon_google_docstring = False
+napoleon_use_param = False
diff --git a/doc/make.py b/doc/make.py
@@ -60,7 +60,7 @@ def htmlhelp():
    with open('build/htmlhelp/index.html', 'r+') as fh:
        content = fh.read()
        fh.seek(0)
-        content = re.sub(r'<script>.*?</script>', '', content, 
+        content = re.sub(r'<script>.*?</script>', '', content,
                         flags=re.MULTILINE| re.DOTALL)
        fh.write(content)
        fh.truncate()