From 70e6bc0466c90714f7ae4f2f70934f358a373670 Mon Sep 17 00:00:00 2001 From: ted Date: Mon, 24 Jun 2019 14:18:12 -0700 Subject: [PATCH] add some links to the main page Basically linked things I had to google/look up on my own. There are a million things that _could_ be linked, but using myself as a median Python coder, it seems about right. Removed italics because I can't figure out how to use them with a link. --- docs/source/index.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index dbd4e85..959d87f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -36,20 +36,21 @@ A familiar HTTP Service Framework Powered by `Starlette `_. That ``async`` declaration is optional. -This gets you a ASGI app, with a production static files server (WhiteNoise) +This gets you a ASGI app, with a production static files server +(`WhiteNoise `_) pre-installed, jinja2 templating (without additional imports), and a -production webserver based on uvloop, serving up requests with gzip -compression automatically. +production webserver based on uvloop, serving up requests with +automatic gzip compression. Features -------- - A pleasant API, with a single import statement. - Class-based views without inheritance. -- ASGI framework, the future of Python web services. +- `ASGI `_ framework, the future of Python web services. - WebSocket support! - The ability to mount any ASGI / WSGI app at a subroute. -- *f-string syntax* route declaration. +- `f-string syntax `_ route declaration. - Mutable response object, passed into each view. No need to return anything. - Background tasks, spawned off in a ``ThreadPoolExecutor``. - GraphQL (with *GraphiQL*) support! @@ -129,7 +130,7 @@ Ideas - Automatic gzipped-responses. - In addition to Falcon's ``on_get``, ``on_post``, etc methods, Responder features an ``on_request`` method, which gets called on every type of request, much like Requests. - A production static files server is built-in. -- Uvicorn built-in as a production web server. I would have chosen Gunicorn, but it doesn't run on Windows. Plus, Uvicorn serves well to protect against slowloris attacks, making nginx unnecessary in production. +- `Uvicorn `_ is built-in as a production web server. I would have chosen Gunicorn, but it doesn't run on Windows. Plus, Uvicorn serves well to protect against `slowloris `_ attacks, making nginx unnecessary in production. - GraphQL support, via Graphene. The goal here is to have any GraphQL query exposable at any route, magically.