Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Use official numpydoc extension #24098

Merged
merged 11 commits into from
Dec 15, 2018
Merged
1 change: 1 addition & 0 deletions ci/deps/travis-36-doc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ dependencies:
- notebook
- numexpr
- numpy=1.13*
- numpydoc
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have a min version required?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know exactly. Currently it uses the latest which is 0.8.0.

- openpyxl
- pandoc
- pyarrow
Expand Down
48 changes: 37 additions & 11 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,10 @@
import importlib
import logging
import warnings

from sphinx.ext.autosummary import _import_by_name
from numpydoc.docscrape import NumpyDocString
from numpydoc.docscrape_sphinx import SphinxDocString

logger = logging.getLogger(__name__)

Expand Down Expand Up @@ -49,10 +52,6 @@

])

# numpydoc is available in the sphinxext directory, and can't be imported
# until sphinxext is available in the Python path
from numpydoc.docscrape import NumpyDocString

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

# Add any Sphinx extension module names here, as strings. They can be
Expand All @@ -64,7 +63,7 @@
'sphinx.ext.doctest',
'sphinx.ext.extlinks',
'sphinx.ext.todo',
'numpydoc',
'numpydoc', # handle NumPy documentation formatted docstrings
'IPython.sphinxext.ipython_directive',
'IPython.sphinxext.ipython_console_highlighting',
'matplotlib.sphinxext.plot_directive',
Expand Down Expand Up @@ -102,12 +101,6 @@
if any(re.match(r"\s*api\s*", l) for l in index_rst_lines):
autosummary_generate = True

# numpydoc
# for now use old parameter listing (styling + **kwargs problem)
numpydoc_use_blockquotes = True
# use member listing for attributes
numpydoc_attributes_as_param_list = False

# matplotlib plot directive
plot_include_source = True
plot_formats = [("png", 90)]
Expand Down Expand Up @@ -420,6 +413,39 @@
]


def sphinxdocstring_str(self, indent=0, func_role="obj"):
# Pandas displays Attributes section in style like Methods section

# Function is copy of `SphinxDocString.__str__`
ns = {
'signature': self._str_signature(),
'index': self._str_index(),
'summary': self._str_summary(),
'extended_summary': self._str_extended_summary(),
'parameters': self._str_param_list('Parameters'),
'returns': self._str_returns('Returns'),
'yields': self._str_returns('Yields'),
'other_parameters': self._str_param_list('Other Parameters'),
'raises': self._str_param_list('Raises'),
'warns': self._str_param_list('Warns'),
'warnings': self._str_warnings(),
'see_also': self._str_see_also(func_role),
'notes': self._str_section('Notes'),
'references': self._str_references(),
'examples': self._str_examples(),
# Replaced `self._str_param_list('Attributes', fake_autosummary=True)`
# with `self._str_member_list('Attributes')`
'attributes': self._str_member_list('Attributes'),
'methods': self._str_member_list('Methods'),
}
ns = {k: '\n'.join(v) for k, v in ns.items()}

rendered = self.template.render(**ns)
return '\n'.join(self._str_indent(rendered.split('\n'), indent))


SphinxDocString.__str__ = sphinxdocstring_str

# Add custom Documenter to handle attributes/methods of an AccessorProperty
# eg pandas.Series.str and pandas.Series.dt (see GH9322)

Expand Down
94 changes: 0 additions & 94 deletions doc/sphinxext/numpydoc/LICENSE.txt

This file was deleted.

51 changes: 0 additions & 51 deletions doc/sphinxext/numpydoc/README.rst

This file was deleted.

8 changes: 0 additions & 8 deletions doc/sphinxext/numpydoc/__init__.py

This file was deleted.

Loading