Browse Source

Tweaked autodoc to skip :internal: methods.

pull/300/head
Armin Ronacher 13 years ago
parent
commit
ae00f6d149
  1. 4
      docs/conf.py
  2. 16
      docs/flaskdocext.py
  3. 4
      flask/app.py

4
docs/conf.py

@ -17,6 +17,7 @@ import sys, os
# add these directories to sys.path here. If the directory is relative to the # 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. # 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('_themes'))
sys.path.append(os.path.abspath('.'))
# -- General configuration ----------------------------------------------------- # -- 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 # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # 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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']

16
docs/flaskdocext.py

@ -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)

4
flask/app.py

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

Loading…
Cancel
Save