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