Commit graph

1374 commits

Author SHA1 Message Date
Chris Lamb
d3a16a9895 Make the documentation build reproducibly
Whilst working on the Reproducible Builds effort [0] we noticed that
flask could not be built reproducibly.

This is because it includes an absolute build directory in the
documentation as the "json_module" attribute points to a Python class/
module which has a string representation including its path.

This commit skips this (inherited) member from the documentation.

(This was originally filed in Debian as #943674 [1].)

 [0] https://reproducible-builds.org/
 [1] https://bugs.debian.org/943674
2019-10-28 09:16:53 +00:00
David Lord
a620f1c9c8 clean up config.from_file docs 2019-10-18 09:24:58 -07:00
pgjones
35627192e7 Support loading configuration from text files
TOML is a very popular format now, and is taking hold in the Python
ecosystem via pyproject.toml (among others). This allows toml config
files via,

    app.config.from_file("config.toml", toml.loads)

it also allows for any other file format whereby there is a loader
that takes a string and returns a mapping.
2019-10-18 09:15:47 -07:00
Marat Sharafutdinov
355e0f73b1 Update reqcontext.rst 2019-10-14 23:48:48 +03:00
David Lord
b0af51baf4 Merge pull request #3391 from pallets/explain-escape
explain escape at top of quickstart
2019-10-12 19:03:34 -07:00
David Lord
e3be566d76 explain escape at top of quickstart
* introduce escape, and explain why it's omitted in examples
* clean up imports in examples
2019-10-12 18:53:47 -07:00
David Lord
a8da6b5fed Merge branch '1.1.x' 2019-09-24 06:44:36 -07:00
David Lord
ea659d77e5 Merge branch '1.0.x' into 1.1.x 2019-09-24 06:44:18 -07:00
David Lord
6ee61a8b57 Merge branch '0.12.x' into 1.0.x 2019-09-24 06:43:25 -07:00
David Lord
aef114e372 update docs for new theme 2019-09-24 06:35:10 -07:00
bearnun
fc326d3599 mention default logging level 2019-09-23 12:17:46 -07:00
David Lord
f4a1ea7563 Merge branch '1.1.x' 2019-09-23 12:11:18 -07:00
David Lord
286b84c370 Merge branch '1.0.x' into 1.1.x 2019-09-23 12:10:55 -07:00
David Lord
7c206114fa reword extension python version item 2019-09-23 11:59:59 -07:00
David Lord
d3581e97c4 Merge branch '1.1.x' 2019-09-23 08:38:29 -07:00
David Lord
d5a739fae5 Merge branch '1.0.x' into 1.1.x 2019-09-23 08:38:11 -07:00
David Lord
4504c6d7b8 update patterns, snippets, extensions docs 2019-09-23 08:19:40 -07:00
Nathan McKinley-Pace
992e20b021 Update testing.rst
It now describes how to install flaskr using pip so that all tests pass.
2019-09-02 11:31:34 -04:00
Constantin
1c383fc13f fix typo: base on -> based on 2019-08-25 20:33:41 +02:00
Eido95
0f96fec7bc docs: Change max content length value to megabyte
16 * 1024 * 1024 = 16 MiB (Mebibyte)
16 * 1000 * 1000 = 16 MB (Megabyte)

The example is in megabytes, not in mebibytes.
2019-08-13 11:02:56 +03:00
David Lord
4f3db0862a fix stylecheck 2019-08-01 13:35:38 -07:00
David Lord
50a3d54a5b Merge branch '1.0.x' into 1.1.x 2019-08-01 13:08:12 -07:00
Csirmaz Bendegúz
59ef0883f7 Fix typo in urlprocessors.rst 2019-08-01 12:58:07 -07:00
Grey Li
a1c23b2fe7 Fix github link generator for docs 2019-08-01 22:49:31 +08:00
David Lord
a30c2d8ae3 Merge branch '1.0.x' into 1.1.x 2019-07-22 13:31:05 -07:00
Grey Li
411055c52b Update outdated extension doc
Remove links and descriptions relate to abandoned "Flask Extension
Registry" in documentation
2019-07-22 13:23:57 -07:00
Stéphane Wirtel
62191cb38c Documentation: Use Python 3.5+ 2019-07-10 19:03:10 +02:00
David Lord
ba1fcd1887 use app.name as app.logger name 2019-07-01 14:56:18 -07:00
David Lord
1ee9405ff3 Merge branch '1.0.x' 2019-07-01 10:54:31 -07:00
Anthony Sottile
f65c6d3860 Fixes for PEP451 import loaders and pytest 5.x
- pytest 5.x drops python2 compatibility and therefore only implements PEP 451
- pytest 5.x made the repr of `ExcInfo` less confusing (fixed tests depending
  on the old format)
2019-07-01 10:43:06 -07:00
David Lord
ff0c92a1c7 Merge branch '1.0.x' 2019-06-23 16:57:52 -07:00
David Lord
363741ec69 fix docks linkcheck 2019-06-23 15:37:51 -07:00
David Lord
fd0f91a1fb update docs config 2019-06-23 12:27:25 -07:00
David Lord
9e7c91115c use sphinx-issues, rewrap changelog 2019-06-23 12:25:38 -07:00
David Lord
e066e9f9e3 standardize license and copyright 2019-06-22 13:09:09 -07:00
David Lord
ea0968869b use dashes for command names 2019-06-21 08:47:27 -07:00
David Lord
08404e8cd0 document behavior of very generic error handlers 2019-06-21 08:22:35 -07:00
David Lord
3ab901146c reword api error section 2019-06-12 11:02:53 -07:00
Logan Wright
bd6111273b adds api error handling documentation 2019-06-12 10:54:12 -07:00
David Lord
65b453b692 Merge remote-tracking branch 'origin/1.0.x' 2019-06-01 06:53:29 -07:00
Jon S. Stumpf
4dc9c68d19 address flake8 issues 2019-06-01 06:31:35 -07:00
Jon S. Stumpf
8577b347a7 add pre-commit config for flake8 2019-06-01 09:13:46 -04:00
David Lord
d6b3e5eccf Merge pull request #3244 from paulgb/master
Clarify documentation about how url_for uses configuration values (#2759)
2019-06-01 08:59:01 -04:00
Paul Butler
931d62c892 Clarify documentation about how url_for uses configuration values (#2759) 2019-05-31 15:33:06 -04:00
Diego Alberto Torres Quintanilla
d296df03c2 Guard against missing request context in logging docs. 2019-05-31 14:54:03 -04:00
David Lord
797fb5f64b Merge pull request #3240 from ultimecia7/docfix
Fix testing documentation to demonstrate using test client with teardown
2019-05-31 14:06:54 -04:00
ultimecia7
ffdc3ff595 Fix testing documentation to demonstrate using test client with teardown 2019-05-31 13:18:54 -04:00
Anthony Plunkett
cc2580af09 Add Blueprint level cli command registration
Implements #1357.
Adds ability to register click cli commands onto blueprint.
2019-05-24 14:43:29 -07:00
David Lord
6d8c7c987d add quickstart about JSON responses 2019-05-24 10:28:12 -07:00
pgjones
9e0bd76d2a Allow dictionary return values as JSON
This supports an increasingly common usecase whereby JSON is the
primary response (rather than a templated string). Given Flask has a
short syntax for HTML reponses, it seems fitting that it should also
do so for JSON responses. In practice it allows,

     @app.route("/")
     def index():
         return {
             "api_stuff": "values",
         }
2019-05-24 09:48:55 -07:00