Raphael Deem
724c03630a
Update extensions.md
2017-03-26 11:49:15 -07:00
itiel
b00b2561e5
add sanic-nginx-docker-example to extensions.md
2017-03-26 21:16:03 +03:00
Raphael Deem
c5b50fe3cf
allow setting config from individual env variables
2017-03-25 17:45:55 -07:00
Pete Wildsmith
65ae7669f9
Document synchronous response.write in streaming
...
The Streaming section of the docs was updated to make clear that a synchronous write should be used in the callback, but this section was not updated.
2017-03-24 10:11:30 +00:00
Raphael Deem
536140340e
Merge pull request #585 from subyraman/listener-docs
...
add docs for server lifecycle listeners and `add_task`
2017-03-23 18:38:48 -07:00
Suby Raman
6188891a53
add-listeners-docs
2017-03-23 15:49:23 -04:00
Raphael Deem
563bc34fb5
Merge pull request #578 from messense/feature/gunicorn-deploy-doc
...
Add documentation for Gunicorn worker
2017-03-23 12:20:00 -07:00
Suby Raman
b776c37b36
add decorator docs
2017-03-23 15:16:46 -04:00
messense
3d9927dee0
Add documentation for Gunicorn worker
2017-03-23 09:12:23 +08:00
Shawn Niederriter
a379ef6781
Added Sanic-OAuth to extensions.
2017-03-18 23:56:11 -04:00
lixxu
94c83c445f
fix broken table
2017-03-17 14:01:54 +08:00
lixxu
625865412f
update function name as it not halt request actually
2017-03-17 13:12:17 +08:00
Cadel Watson
24f745a334
Fix formatting errors in RST files
2017-03-16 16:51:02 +11:00
Cadel Watson
86f3101861
Add autodoc extension to Sphinx configuration
2017-03-16 16:50:33 +11:00
Anton Zhyrnyi
410f86c960
fix for docs&tests
2017-03-14 20:53:58 +02:00
Raphael Deem
85f27320e7
Merge pull request #553 from ashleysommer/ashleysommer-add-dispatch-extension
...
Add Dispatcher Extension to Extensions page in Docs
2017-03-13 17:00:46 -07:00
Raphael Deem
9a3fac90e1
Merge pull request #551 from messense/feature/documentation-links
...
Add hyperlinks in response documentation
2017-03-13 17:00:00 -07:00
Ashley Sommer
d05f502fc8
Add Dispatcher Extension
...
Adds a link to the extension
https://github.com/ashleysommer/sanic-dispatcher
And a very short description
2017-03-14 08:37:53 +10:00
Jing Su
ba41ab8f67
fix typo
2017-03-13 18:36:22 +08:00
messense
48a26fd5df
Add hyperlinks in response documentation
2017-03-13 16:20:12 +08:00
messense
d174917a07
Add response documentation
2017-03-12 14:31:51 +08:00
Raphael Deem
88bf78213f
Merge pull request #512 from subyraman/fix-url-building
...
Fix `request.url` and other url properties
2017-03-10 00:38:16 -08:00
Raphael Deem
313edadf47
Merge pull request #528 from r0fls/523
...
allow running with SSL via commandline
2017-03-10 00:35:46 -08:00
Lix Xu
893977365c
Update extensions.md
...
add babel extension
2017-03-09 23:58:02 +08:00
Raphael Deem
2ba30f2022
allow running with SSL via commandline
2017-03-07 19:57:10 -08:00
Eli Uriegas
19592e8eea
Merge pull request #473 from subyraman/explore-streams-v2
...
Add `stream` method for streaming content, add docs and examples
2017-03-05 17:51:44 -08:00
Eli Uriegas
8e6678d526
Merge pull request #469 from miguelgrinberg/websocket-support
...
websocket support
2017-03-05 17:42:49 -08:00
Suby Raman
e792a1e030
add host test
2017-03-03 14:51:13 -05:00
Suby Raman
69bd63b742
add docs
2017-03-03 11:59:33 -05:00
James Stidard
f7186f5331
Sanic EnvConfig
...
Services like Heroku force your hand into using environment variables. Made this to help.
2017-03-02 21:22:07 +00:00
bohea
3289e8403a
Update extensions.md
2017-02-28 17:34:40 +08:00
Miguel Grinberg
40ccb4a0dd
websocket documentation
2017-02-27 22:35:28 -08:00
Suby Raman
4232f5342e
correct indendation
2017-02-23 11:47:39 -05:00
Suby Raman
a36e815227
Add documentation about request.app
2017-02-23 11:42:59 -05:00
Eli Uriegas
64f73f624f
Merge pull request #471 from r0fls/vhost-default
...
allow default vhost
2017-02-22 11:08:28 -06:00
Suby Raman
d8a6d7e02f
response.write should be synchronous for performance reasons
2017-02-22 10:42:16 -05:00
Raphael Deem
a57ec9e669
remove websocket extension
2017-02-21 15:30:42 -08:00
Suby Raman
1a8961587c
more info in docs
2017-02-21 11:38:57 -05:00
Suby Raman
4e8aac4b41
rebase
2017-02-21 11:05:06 -05:00
Raphael Deem
9c72b557ec
allow default vhost
2017-02-20 16:52:36 -08:00
Tommy Ip
4b7e7aab33
Fix typo in routing.md
2017-02-19 12:39:39 +00:00
Suby Raman
70b7606cb8
add sanic_compress extension
2017-02-18 19:53:32 -05:00
Lix Xu
f553ca95a5
add user_agent to request
2017-02-17 15:12:07 +08:00
Typhon
7d9acc3c36
Adding sanic_crud to extensions
2017-02-16 09:49:48 -08:00
Suby Raman
6ea5a4719a
add url_for doc in blueprint
2017-02-16 11:48:31 -05:00
Suby Raman
f8c50b7f1e
fix blueprints documentation
2017-02-16 11:46:19 -05:00
Eli Uriegas
feb1f1d71a
Merge pull request #444 from lixxu/master
...
simple motor wrapper
2017-02-16 09:46:09 -06:00
Lix Xu
550afc27dc
simple motor wrapper
2017-02-16 22:36:16 +08:00
Eli Uriegas
874698b93f
Merge pull request #431 from subyraman/test-client-v2
...
Add Flask-like `test_client` to replace `sanic_endpoint_test`
2017-02-15 15:44:30 -06:00
Lix Xu
6b391b701b
simple pagination support
2017-02-15 13:27:58 +08:00
Suby Raman
7726ffa3f7
remove documentation about passing in the loop
2017-02-14 15:44:43 -05:00
Suby Raman
d5633b3705
fix deprecation message
2017-02-14 15:16:58 -05:00
Suby Raman
3b68dc72e7
rework testing
2017-02-14 14:51:20 -05:00
Eli Uriegas
286dc3c32b
Merge pull request #399 from lixxu/master
...
improve url_for to support multi values and special options
2017-02-14 10:27:54 -06:00
growingdever
d57d90fe6b
- make blueprint add_route method support view instance
...
- update documentation that doesn't specify url_prefix parameter
2017-02-14 14:23:22 +09:00
lixxu
4839ede64f
update test for url_for and update routing.md doc
2017-02-14 10:26:30 +08:00
Eli Uriegas
1660041470
Merge pull request #408 from agoose77/master
...
Use app decorator instead of run arguments for before_start
2017-02-13 12:54:46 -06:00
Raphael Deem
7944cff7a5
add extension to docs
2017-02-11 15:31:58 -08:00
Angus Hollands
b5e50ecb75
Use app decorator instead of run arguments for before_start
...
Mirror listener of blueprints
2017-02-11 14:30:17 +00:00
Suby Raman
5c63ce666c
punctuation
2017-02-02 14:21:59 -05:00
Suby Raman
f9056099f9
all works
2017-02-02 12:52:48 -05:00
Eli Uriegas
c91d264ff1
Merge pull request #380 from channelcat/openapi-extension
...
Added sanic-openapi to extensions
2017-01-31 07:39:38 -06:00
Channel Cat
34966fb182
Added sanic-openapi to extensions
2017-01-31 01:24:41 -08:00
Raphael Deem
1501c56bbc
update route method docs
2017-01-30 16:42:43 -08:00
Jordan Pittier
82680bf43f
Fix docs/config.md: the MYAPP_SETTINGS is not exported
...
If we don"t `export` the variable, it's not available in subcommand:
MYAPP_SETTINGS=/path/to/config_file; python3 -c "import os; os.environ['MYAPP_SETTINGS']"
Traceback (most recent call last):
File "<string>", line 1, in <module>
File "/usr/lib/python3.5/os.py", line 725, in __getitem__
raise KeyError(key) from None
KeyError: 'MYAPP_SETTINGS'
The ';' is the culprit here.
2017-01-30 10:39:02 +01:00
Channel Cat
52e485cce9
Fix readthedocs includes
2017-01-29 16:46:16 -08:00
Channel Cat
2a9496fcda
Fix readthedocs build
2017-01-29 16:25:22 -08:00
Eli Uriegas
8db0ece459
Merge branch 'master' into read-the-docs
2017-01-29 15:31:22 -06:00
Eli Uriegas
f56c5e3a45
Merge pull request #199 from Tim-Erwin/improved_config
...
added methods to load config from a file
2017-01-29 15:27:34 -06:00
Channel Cat
0eaccea38f
updated project name in docs build
2017-01-29 12:49:59 -08:00
Channel Cat
de32c389d0
Added basic readthedocs support
2017-01-29 12:47:00 -08:00
Cadel Watson
011be51232
Add documentation for the CompositionView class
2017-01-27 09:52:41 +11:00
Channel Cat
b0f71c5304
Fixed default path in documentation
2017-01-25 21:48:39 -08:00
Raphael Deem
a162f2ce34
Merge branch 'master' into cookie-usability
2017-01-25 21:24:30 -08:00
Andrew Bentley
ecd7e5bdd3
Update blueprints docs with correct listener example
2017-01-25 23:01:57 +11:00
Channel Cat
d0a121ad06
Added del cookie and default path
2017-01-25 01:53:39 -08:00
Tim Mundt
5bba3388a0
Merge branch 'master' into improved_config
2017-01-25 09:36:21 +01:00
Lix Xu
a9ee01c7ec
add sanic-jinja2 extension
2017-01-24 15:34:32 +08:00
Eli Uriegas
596bb54ee3
Oops on 2 of the non-relative links
2017-01-19 21:26:37 -06:00
Eli Uriegas
7554e87374
Fixes doc link extensions from .html to .md
...
Whoops! Totally missed that all the links pointed to `.html` files
instead of `.md` files
2017-01-19 21:24:08 -06:00
Cadel Watson
6176964bdf
Clarify, reformat, and add to documentation guides ( #318 )
...
* Reorder and clarify the 'Request Data' guide, adding a section on RequestParameters
* Clarify routing guide, adding introduction and HTTP types sections
* Clarify the use-cases of middleware
* Clean up formatting in the exceptions guide and add some common exceptions.
* Fix formatting of blueprints and add use-case example.
* Clarify the class-based views guide
* Clarify and fix formatting of cookies guide
* Clarify static files guide
* Clarify the custom protocols guide.
* Add more information to the deploying guide
* Fix broken list in the community extensions list.
* Add introduction and improve warning to contributing guide
* Expand getting started guide
* Reorder guides and add links between them
* Standardise heading capitalisation
2017-01-19 21:18:52 -06:00
Cadel Watson
30862c0a3e
Update documentation generation instructions.
2017-01-20 09:32:08 +11:00
Cadel Watson
ebce7b01c7
Add new guides to documentation index
2017-01-19 08:54:20 +11:00
Cadel Watson
9d4b104d2d
Merge branch 'master' into sphinx-docs
2017-01-19 08:48:54 +11:00
Ubuntu
2cf4baddfb
Moved Remote-Addr header to request.ip so it can be pulled on-demand
2017-01-16 23:27:50 +00:00
Tim Mundt
0b9094d348
Merge branch 'master' into improved_config
2017-01-13 12:34:56 +01:00
Raphael Deem
a86cc32dff
Update extensions.md
...
Since there have been a few extensions discussed in open issues, it makes sense to start keeping track of them.
2017-01-12 19:30:22 -08:00
Raphael Deem
974c857a97
add a list of extensions
2017-01-12 19:25:08 -08:00
Cadel Watson
385328ffd5
Generate API documentation in the _api folder
2017-01-10 09:41:00 +11:00
Cadel Watson
34d1e5e67e
Convert README to RestructuredText and include it in the documentation index.
2017-01-10 09:28:33 +11:00
Anton Zhyrney
47a4f34cdf
tests&small update
2017-01-07 07:13:49 +02:00
Anton Zhyrney
1317b1799c
add docstrings&updated docs
2017-01-07 06:57:07 +02:00
Eli Uriegas
4ccc782e29
Merge pull request #209 from 38elements/protocol
...
Customizable protocol
2017-01-03 11:52:54 -06:00
Anton Zhyrney
e7314d1775
fix misprints&renaming
2016-12-29 19:22:11 +02:00
38elements
ee8f8c2930
Merge branch 'master' into protocol
2016-12-29 16:44:15 +09:00
38elements
64e0e2d19f
Improve custom_protocol.md
2016-12-29 16:41:04 +09:00
38elements
6bb4dae5e0
Fix format in custom_protocol.md
2016-12-29 13:25:04 +09:00
38elements
83e9d08853
Add document for custom protocol
2016-12-29 13:11:27 +09:00
Eli Uriegas
2d4512cd1c
Merge branch 'master' into improved_config
2016-12-25 15:26:33 -08:00
Cadel Watson
7654c2f902
Use Sphinx for documentation.
...
This commit creates configuration files and an index page for
documentation using Sphinx. The recommonmark package is used to enable
Markdown support for Sphinx, using the Common Mark specification. This
means that the current documentation doesn't need to be rewritten.
2016-12-25 20:24:34 +11:00
Eli Uriegas
665881471d
Merge pull request #217 from cr0hn/patch-3
...
Upgraded Middlewares doc: Explain how to chain two (or more) middlewares
2016-12-23 22:31:03 -08:00
Eli Uriegas
cd17a42234
Fix some verbage
2016-12-23 09:59:28 -08:00
Eli Uriegas
9e208ab744
Merge pull request #210 from kdelwat/testing-documentation
...
Create documentation for testing server endpoints.
2016-12-23 09:57:22 -08:00
cr0hn
3add40625d
Explain how to chain two (or more) middlewares
...
A funny and useful examples about how to chain middlewares.
2016-12-23 16:07:59 +01:00
Romano Bodha
5c1ef2c1cf
Fixed import error
2016-12-23 01:42:05 +01:00
Cadel Watson
8411255700
Create documentation for testing server endpoints.
...
Currently the sanic.utils functionality is undocumented. This provides
information on the interface as well as a complete example of testing
a server endpoint.
2016-12-23 11:08:04 +11:00
Tim Mundt
ef9edfd160
added documentation for configuration
2016-12-17 20:20:07 +01:00
kamyar
6ef6d9a905
url params docs typo fix
...
add missing '>' in url params docs example
2016-12-11 16:34:22 +02:00
Anton Zhyrney
da4567eea5
changes in doc
2016-11-26 08:44:46 +02:00
Anton Zhyrney
9f2d73e2f1
class based views implementation for sanic
2016-11-25 09:10:25 +02:00
Channel Cat
74ae0007d3
Reverse static arguments
2016-10-25 02:45:28 -07:00
Channel Cat
bf6879e46f
Made static file serving part of Sanic
...
Added sanic.static, blueprint.static, documentation, and testing
2016-10-24 01:21:06 -07:00
Channel Cat
e70263d012
Merge pull request #87 from channelcat/blueprint-extras
...
Blueprint start/stop listeners + ordering
2016-10-23 02:04:55 -07:00
Channel Cat
3802141007
Adding cookie capabilities for issue #74
2016-10-23 01:32:16 -07:00
Channel Cat
50ae2048cc
Merge pull request #93 from rogererens/patch-1
...
Fix typos
2016-10-22 03:07:14 -07:00
Channel Cat
b21ab3db12
Merge pull request #91 from pcdinh/master
...
Document `request.body` as a way to get raw POST body
2016-10-22 03:04:34 -07:00
narzeja
113047d450
Simple blueprint was missing the 'request' parameter
2016-10-22 07:13:14 +02:00
Roger Erens
268a87e3b4
Fix typos
...
I guess renaming was forgotten in a copy-n-paste frenzy?!
2016-10-21 23:47:13 +02:00
pcdinh
452764a8eb
Document request.body as a way to get raw POST body
2016-10-22 01:35:38 +07:00
Channel Cat
f540f1e7c4
reverting reverted change
2016-10-21 04:32:05 -07:00
Channel Cat
9b561e83e3
Revert "."
...
This reverts commit 77c69e3810
2016-10-21 04:14:50 -07:00
Channel Cat
77c69e3810
.
2016-10-21 04:11:40 -07:00
Channel Cat
a5614f6880
Added server start/stop listeners and reverse ordering on response middleware to blueprints
2016-10-21 04:11:18 -07:00
Kyle Frost
3c05382e07
Fix routing doc typo
2016-10-18 08:13:37 -04:00
Channel Cat
6f105a647e
Added multiprocessing
2016-10-18 01:22:49 -07:00
Channel Cat
0c28cdbaf4
Correcting blueprint documentation
...
issue #37
2016-10-16 14:28:42 -07:00
abhishek7
3c7a8a5f45
Added some documentation to request.py, removed extra line in blueprints.py, and minor grammar enhancements to blueprints.md and middleware.md
2016-10-16 11:35:45 -04:00
Channel Cat
7ceba1ae9d
Changed install instructions to use pypi
2016-10-16 02:58:17 -07:00
narzeja
48a8ebbde3
added descriptions for middleware/exceptions in blueprint documentation
2016-10-16 11:20:08 +02:00
Channel Cat
2ba2ee156d
Added documentation for middleware and exceptions in blueprints
2016-10-16 01:59:04 -07:00
Channel Cat
9b716e97ee
Merge branch 'feature_blueprints' of https://github.com/narzeja/sanic into narzeja-feature_blueprints
2016-10-16 08:21:35 +00:00
narzeja
aaf571fae4
Blueprint support, with docs, example, and tests
2016-10-16 06:43:22 +02:00
Andrew Murray
e3a6262012
Fixed typos
2016-10-16 12:28:24 +11:00
channelcat
475880765e
Merge pull request #16 from cbess/patch-3
...
Fix list formatting in Request Data docs
2016-10-15 16:23:23 -07:00
channelcat
e16a5a3a27
Merge pull request #15 from cbess/patch-2
...
Fix Sanic arg in docs
2016-10-15 13:40:13 -07:00
channelcat
59fc17b19e
Merge pull request #14 from cbess/patch-1
...
Fix route arg; update regex
2016-10-15 13:39:56 -07:00
João Costa
ce7a34b608
Update routing.md <PARAM>
...
Some markdown readers (such as github's preview) parse `<PARAM>` as an HTML tag.
Wrapping it in a code block fixes that.
2016-10-15 19:30:44 +01:00
C. Bess
9d7488f59d
Fix list formatting in Request Data docs
...
Added two spaces after line to force newline in markdown. Code emphasized in lists.
2016-10-15 13:09:16 -05:00
C. Bess
365adc1fda
Fix Sanic arg
...
I assume the value of `__name__` (module name) was intended.
2016-10-15 13:05:44 -05:00
C. Bess
8cade2f664
Fix route arg; update regex
...
Fixed a potential "copy/paste" error in the `person_handler`. Simplify route regex.
2016-10-15 13:03:05 -05:00
Channel Cat
91a780230e
.
2016-10-14 05:01:18 -07:00
Channel Cat
79593574a6
.
2016-10-14 05:00:43 -07:00
Channel Cat
35ed7ceefb
.
2016-10-14 04:58:09 -07:00
Channel Cat
5a7447e975
Basic documentation
2016-10-14 04:51:08 -07:00
Channel Cat
a74ab9bd18
Added tests and middleware, and improved documentation
2016-10-14 03:23:48 -07:00
