maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Merge pull request #2686 from davidism/bp-static

Browse source 
document blueprint static folder without prefix
This commit is contained in:
David Lord 2018-04-09 01:27:25 -07:00 • committed by GitHub
commit abba4b2a74
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/blueprints.rst
View file

@ -151,23 +151,31 @@ To quickly open sources from this folder you can use the
Static Files Static Files
```````````` ````````````
A blueprint can expose a folder with static files by providing a path to a A blueprint can expose a folder with static files by providing the path
folder on the filesystem via the `static_folder` keyword argument. It can to the folder on the filesystem with the ``static_folder`` argument.
either be an absolute path or one relative to the folder of the It is either an absolute path or relative to the blueprint's location::
blueprint::
admin = Blueprint('admin', __name__, static_folder='static') admin = Blueprint('admin', __name__, static_folder='static')
By default the rightmost part of the path is where it is exposed on the By default the rightmost part of the path is where it is exposed on the
web. Because the folder is called :file:`static` here it will be available at web. This can be changed with the ``static_url`` argument. Because the
the location of the blueprint + ``/static``. Say the blueprint is folder is called ``static`` here it will be available at the
registered for ``/admin`` the static folder will be at ``/admin/static``. ``url_prefix`` of the blueprint + ``/static``. If the blueprint
has the prefix ``/admin``, the static URL will be ``/admin/static``.
The endpoint is named `blueprint_name.static` so you can generate URLs to The endpoint is named ``blueprint_name.static``. You can generate URLs
it like you would do to the static folder of the application:: to it with :func:`url_for` like you would with the static folder of the
application::
url_for('admin.static', filename='style.css') url_for('admin.static', filename='style.css')
However, if the blueprint does not have a ``url_prefix``, it is not
possible to access the blueprint's static folder. This is because the
URL would be ``/static`` in this case, and the application's ``/static``
route takes precedence. Unlike template folders, blueprint static
folders are not searched if the file does not exist in the application
static folder.
Templates Templates
````````` `````````