From 3fd9c29bd7ef91853476ba5bdfb41994e5e302f1 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 6 Nov 2013 14:58:15 +0100 Subject: [PATCH] DOC: remove docstring of flags attribute during doc building process (#5331) --- doc/source/conf.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index a500289b27ab1..695a954f78cfb 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -246,3 +246,12 @@ 'GH'), 'wiki': ('https://github.com/pydata/pandas/wiki/%s', 'wiki ')} + +# remove the docstring of the flags attribute (inherited from numpy ndarray) +# because these give doc build errors (see GH issue 5331) +def remove_flags_docstring(app, what, name, obj, options, lines): + if what == "attribute" and name.endswith(".flags"): + del lines[:] + +def setup(app): + app.connect("autodoc-process-docstring", remove_flags_docstring)