From 7554e8737468334df78e0ff6d92a83fa897859a9 Mon Sep 17 00:00:00 2001 From: Eli Uriegas Date: Thu, 19 Jan 2017 21:24:08 -0600 Subject: [PATCH 1/2] Fixes doc link extensions from .html to .md Whoops! Totally missed that all the links pointed to `.html` files instead of `.md` files --- docs/blueprints.md | 4 ++-- docs/class_based_views.md | 4 ++-- docs/contributing.md | 2 +- docs/cookies.md | 4 ++-- docs/custom_protocol.md | 6 +++--- docs/deploying.md | 6 +++--- docs/exceptions.md | 4 ++-- docs/extensions.md | 4 ++-- docs/getting_started.md | 2 +- docs/middleware.md | 4 ++-- docs/request_data.md | 4 ++-- docs/routing.md | 4 ++-- docs/static_files.md | 4 ++-- docs/testing.md | 4 ++-- 14 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/blueprints.md b/docs/blueprints.md index ee3eab46..65907750 100644 --- a/docs/blueprints.md +++ b/docs/blueprints.md @@ -159,6 +159,6 @@ app.blueprint(blueprint_v2) app.run(host='0.0.0.0', port=8000, debug=True) ``` -**Previous:** [Exceptions](exceptions.html) +**Previous:** [Exceptions](exceptions.md) -**Next:** [Class-based views](class_based_views.html) +**Next:** [Class-based views](class_based_views.md) diff --git a/docs/class_based_views.md b/docs/class_based_views.md index e34f432b..0cf7f770 100644 --- a/docs/class_based_views.md +++ b/docs/class_based_views.md @@ -77,6 +77,6 @@ class ViewWithDecorator(HTTPMethodView): app.add_route(ViewWithDecorator.as_view(), '/url') ``` -**Previous:** [Blueprints](blueprints.html) +**Previous:** [Blueprints](blueprints.md) -**Next:** [Cookies](cookies.html) +**Next:** [Cookies](cookies.md) diff --git a/docs/contributing.md b/docs/contributing.md index a8fabc69..dde57270 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -32,4 +32,4 @@ Sanic without significant gains in usability, security, or features may not be merged. Please don't let this intimidate you! If you have any concerns about an idea, open an issue for discussion and help. -**Previous:** [Sanic extensions](extensions.html) +**Previous:** [Sanic extensions](extensions.md) diff --git a/docs/cookies.md b/docs/cookies.md index 5a933de0..c29a1f32 100644 --- a/docs/cookies.md +++ b/docs/cookies.md @@ -47,6 +47,6 @@ parameters available: - `httponly` (boolean): Specifies whether the cookie cannot be read by Javascript. -**Previous:** [Class-based views](class_based_views.html) +**Previous:** [Class-based views](class_based_views.md) -**Next:** [Custom protocols](custom_protocol.html) +**Next:** [Custom protocols](custom_protocol.md) diff --git a/docs/custom_protocol.md b/docs/custom_protocol.md index 42e0135a..67b732a2 100644 --- a/docs/custom_protocol.md +++ b/docs/custom_protocol.md @@ -5,7 +5,7 @@ You can change the behavior of Sanic's protocol by specifying a custom protocol, which should be a subclass of -[asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes). +[asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.md#protocol-classes). This protocol can then be passed as the keyword argument `protocol` to the `sanic.run` method. The constructor of the custom protocol class receives the following keyword @@ -71,6 +71,6 @@ async def response(request): app.run(host='0.0.0.0', port=8000, protocol=CustomHttpProtocol) ``` -**Previous:** [Cookies](cookies.html) +**Previous:** [Cookies](cookies.md) -**Next:** [Testing](testing.html) +**Next:** [Testing](testing.md) diff --git a/docs/deploying.md b/docs/deploying.md index 8d0dcde6..88aedfe8 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -23,7 +23,7 @@ keyword arguments: specified, Sanic creates its own event loop. - `protocol` *(default `HttpProtocol`)*: Subclass of - [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes). + [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.md#protocol-classes). ## Workers @@ -54,6 +54,6 @@ if __name__ == '__main__': app.run(host='0.0.0.0', port=1337, workers=4) ``` -**Previous:** [Request Data](request_data.html) +**Previous:** [Request Data](request_data.md) -**Next:** [Static Files](static_files.html) +**Next:** [Static Files](static_files.md) diff --git a/docs/exceptions.md b/docs/exceptions.md index add0a3e4..8a294492 100644 --- a/docs/exceptions.md +++ b/docs/exceptions.md @@ -44,6 +44,6 @@ Some of the most useful exceptions are presented below: See the `sanic.exceptions` module for the full list of exceptions to throw. -**Previous:** [Middleware](middleware.html) +**Previous:** [Middleware](middleware.md) -**Next:** [Blueprints](blueprints.html) +**Next:** [Blueprints](blueprints.md) diff --git a/docs/extensions.md b/docs/extensions.md index b775f4d2..09c71d42 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -6,6 +6,6 @@ A list of Sanic extensions created by the community. Allows using redis, memcache or an in memory store. - [CORS](https://github.com/ashleysommer/sanic-cors): A port of flask-cors. -**Previous:** [Testing](testing.html) +**Previous:** [Testing](testing.md) -**Next:** [Contributing](contributing.html) +**Next:** [Contributing](contributing.md) diff --git a/docs/getting_started.md b/docs/getting_started.md index 4a062df3..e3a2a31b 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -26,4 +26,4 @@ syntax, so earlier versions of python won't work. You now have a working Sanic server! -**Next:** [Routing](routing.html) +**Next:** [Routing](routing.md) diff --git a/docs/middleware.md b/docs/middleware.md index aef9e093..6adb9328 100644 --- a/docs/middleware.md +++ b/docs/middleware.md @@ -65,6 +65,6 @@ async def halt_response(request, response): return text('I halted the response') ``` -**Previous:** [Static Files](static_files.html) +**Previous:** [Static Files](static_files.md) -**Next:** [Exceptions](exceptions.html) +**Next:** [Exceptions](exceptions.md) diff --git a/docs/request_data.md b/docs/request_data.md index 0826a1c7..555cf765 100644 --- a/docs/request_data.md +++ b/docs/request_data.md @@ -90,6 +90,6 @@ args.get('titles') # => 'Post 1' args.getlist('titles') # => ['Post 1', 'Post 2'] ``` -**Previous:** [Routing](routing.html) +**Previous:** [Routing](routing.md) -**Next:** [Deploying](deploying.html) +**Next:** [Deploying](deploying.md) diff --git a/docs/routing.md b/docs/routing.md index 6d5982a1..d88bcf26 100644 --- a/docs/routing.md +++ b/docs/routing.md @@ -106,6 +106,6 @@ app.add_route(handler2, '/folder/') app.add_route(person_handler2, '/person/', methods=['GET']) ``` -**Previous:** [Getting Started](getting_started.html) +**Previous:** [Getting Started](getting_started.md) -**Next:** [Request Data](request_data.html) +**Next:** [Request Data](request_data.md) diff --git a/docs/static_files.md b/docs/static_files.md index 126b2ed1..5daf7818 100644 --- a/docs/static_files.md +++ b/docs/static_files.md @@ -18,6 +18,6 @@ app.static('/the_best.png', '/home/ubuntu/test.png') app.run(host="0.0.0.0", port=8000) ``` -**Previous:** [Deploying](deploying.html) +**Previous:** [Deploying](deploying.md) -**Next:** [Middleware](middleware.html) +**Next:** [Middleware](middleware.md) diff --git a/docs/testing.md b/docs/testing.md index 47f6564a..bdb85efb 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -50,6 +50,6 @@ def test_endpoint_challenge(): assert response.text == request_data['challenge'] ``` -**Previous:** [Custom protocols](custom_protocol.html) +**Previous:** [Custom protocols](custom_protocol.md) -**Next:** [Sanic extensions](extensions.html) +**Next:** [Sanic extensions](extensions.md) From 596bb54ee37da58bb2fad34db1a912bd7cfe7ff0 Mon Sep 17 00:00:00 2001 From: Eli Uriegas Date: Thu, 19 Jan 2017 21:26:37 -0600 Subject: [PATCH 2/2] Oops on 2 of the non-relative links --- docs/custom_protocol.md | 2 +- docs/deploying.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/custom_protocol.md b/docs/custom_protocol.md index 67b732a2..73d1f1d3 100644 --- a/docs/custom_protocol.md +++ b/docs/custom_protocol.md @@ -5,7 +5,7 @@ You can change the behavior of Sanic's protocol by specifying a custom protocol, which should be a subclass of -[asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.md#protocol-classes). +[asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes). This protocol can then be passed as the keyword argument `protocol` to the `sanic.run` method. The constructor of the custom protocol class receives the following keyword diff --git a/docs/deploying.md b/docs/deploying.md index 88aedfe8..f4d63163 100644 --- a/docs/deploying.md +++ b/docs/deploying.md @@ -23,7 +23,7 @@ keyword arguments: specified, Sanic creates its own event loop. - `protocol` *(default `HttpProtocol`)*: Subclass of - [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.md#protocol-classes). + [asyncio.protocol](https://docs.python.org/3/library/asyncio-protocol.html#protocol-classes). ## Workers