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

View file

@ -17,6 +17,7 @@ import sys, os
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.append(os.path.abspath('_themes'))
sys.path.append(os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
@ -25,7 +26,8 @@ sys.path.append(os.path.abspath('_themes'))
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
'flaskdocext']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

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)

View file

@ -257,7 +257,7 @@ class Flask(_PackageBoundObject):
#: to load a config from files.
self.config = Config(self.root_path, self.default_config)
#: Prepare the deferred setup of the logger.
# Prepare the deferred setup of the logger.
self._logger = None
self.logger_name = self.import_name
@ -1181,7 +1181,7 @@ class Flask(_PackageBoundObject):
the :attr:`before_first_request_funcs` and only exactly once per
application instance (which means process usually).
.. versionadded:: 0.8
:internal:
"""
if self._got_first_request:
return