Skip to content

DOC: clean-up numpydoc patches now numpydoc 0.9 is released #26785

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 11, 2019
Merged

DOC: clean-up numpydoc patches now numpydoc 0.9 is released #26785

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab84356
DOC: clean-up numpydoc patches now numpydoc 0.9 is released
jorisvandenbossche Jun 11, 2019
79727f0
lint
jorisvandenbossche Jun 11, 2019
96deed4
lint
jorisvandenbossche Jun 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 4 additions & 57 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
import jinja2
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 @@ -110,6 +110,9 @@
else None)))
autosummary_generate = True if pattern is None else ['index']

# numpydoc
numpydoc_attributes_as_param_list = False

# matplotlib plot directive
plot_include_source = True
plot_formats = [("png", 90)]
Expand Down Expand Up @@ -422,62 +425,6 @@
]


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


# Fix "WARNING: Inline strong start-string without end-string."
# PR #155 "Escape the * in *args and **kwargs" from numpydoc
# Can be removed after PR merges in v0.9.0
def decorate_process_param(func):
def _escape_args_and_kwargs(name):
if name[:2] == '**':
return r'\*\*' + name[2:]
elif name[:1] == '*':
return r'\*' + name[1:]
else:
return name

def func_wrapper(self, param, desc, fake_autosummary):
param = _escape_args_and_kwargs(param.strip())
return func(self, param, desc, fake_autosummary)

return func_wrapper


func = SphinxDocString._process_param
SphinxDocString._process_param = decorate_process_param(func)

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

Expand Down