Skip to content

Commit 3fd9c29

Browse files
DOC: remove docstring of flags attribute during doc building process (#5331)
1 parent 90bbd6a commit 3fd9c29

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/source/conf.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,3 +246,12 @@
246246
'GH'),
247247
'wiki': ('https://github.com/pydata/pandas/wiki/%s',
248248
'wiki ')}
249+
250+
# remove the docstring of the flags attribute (inherited from numpy ndarray)
251+
# because these give doc build errors (see GH issue 5331)
252+
def remove_flags_docstring(app, what, name, obj, options, lines):
253+
if what == "attribute" and name.endswith(".flags"):
254+
del lines[:]
255+
256+
def setup(app):
257+
app.connect("autodoc-process-docstring", remove_flags_docstring)

0 commit comments

Comments
 (0)