From 383efd24ba5b46060163350ca0042adf3fa90296 Mon Sep 17 00:00:00 2001
From: Marc Garcia <garcia.marc@gmail.com>
Date: Sun, 1 Apr 2018 16:06:40 +0100
Subject: [PATCH] DOC: Adding prefix to autosummary of deprecated docstrings
---
doc/source/conf.py | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 43c7c23c5e20d..8509460f8ca4e 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -16,6 +16,7 @@
import re
import inspect
import importlib
+from sphinx.ext.autosummary import _import_by_name
import warnings
@@ -47,6 +48,10 @@
])
+# 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
@@ -505,9 +510,27 @@ def _replace_pandas_items(self, display_name, sig, summary, real_name):
summary = 'Series plotting accessor and method'
return (display_name, sig, summary, real_name)
+ @staticmethod
+ def _is_deprecated(real_name):
+ try:
+ obj, parent, modname = _import_by_name(real_name)
+ except ImportError:
+ return False
+ doc = NumpyDocString(obj.__doc__ or '')
+ summary = ''.join(doc['Summary'] + doc['Extended Summary'])
+ return '.. deprecated::' in summary
+
+ def _add_deprecation_prefixes(self, items):
+ for item in items:
+ display_name, sig, summary, real_name = item
+ if self._is_deprecated(real_name):
+ summary = '(DEPRECATED) %s' % summary
+ yield display_name, sig, summary, real_name
+
def get_items(self, names):
items = Autosummary.get_items(self, names)
items = [self._replace_pandas_items(*item) for item in items]
+ items = list(self._add_deprecation_prefixes(items))
return items