Browse files

Document the Freezer.root property.

  • Loading branch information...
1 parent 02edbef commit 58a07dd632967fbd9ca63488caed00f7b43b45d8 @SimonSapin committed Mar 18, 2012
Showing with 6 additions and 3 deletions.
  1. +1 −1 docs/index.rst
  2. +4 −1 flask_frozen/__init__.py
  3. +1 −1 tox.ini
View
2 docs/index.rst
@@ -301,7 +301,7 @@ API reference
-------------
.. autoclass:: Freezer
- :members: init_app, register_generator, all_urls, freeze, serve, run
+ :members: init_app, root, register_generator, all_urls, freeze, serve, run
.. autofunction:: walk_directory
View
5 flask_frozen/__init__.py
@@ -111,7 +111,10 @@ def register_generator(self, function):
@property
def root(self):
- """The build destination."""
+ """
+ Absolute path to the directory Frozen-Flask writes to,
+ ie. resolved value for the ``FREEZER_DESTINATION`` configuration_.
+ """
# unicode() will raise if the path is not ASCII or already unicode.
return os.path.join(
unicode(self.app.root_path),
View
2 tox.ini
@@ -1,5 +1,5 @@
[tox]
-envlist = py25, py26, py27; pypy
+envlist = py25, py26, py27, pypy
[testenv]
commands=python -m flask_frozen.tests
changedir=docs

0 comments on commit 58a07dd

Please sign in to comment.