Tweaked autodoc to skip :internal: methods.

This commit is contained in:
Armin Ronacher 2011-08-07 14:15:33 +02:00
parent 02a1317460
commit ae00f6d149
3 changed files with 21 additions and 3 deletions

16
docs/flaskdocext.py Normal file
View file

@ -0,0 +1,16 @@
import re
import inspect
_internal_mark_re = re.compile(r'^\s*:internal:\s*$(?m)')
def skip_member(app, what, name, obj, skip, options):
docstring = inspect.getdoc(obj)
if skip:
return True
return _internal_mark_re.search(docstring or '') is not None
def setup(app):
app.connect('autodoc-skip-member', skip_member)