Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Update Sphinx docs to use README

Browse Source
This commit is contained in:
Adam Hopkins 2021-03-01 23:08:11 +02:00
parent 27f64ddae2
commit e1e9a7cf20
3 changed files with 4 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.rst
View File

@ -7,6 +7,7 @@ Sanic | Build fast. Run fast.
.. start-badges
.. list-table::
:widths: 15 85
:stub-columns: 1
* - Build
@ -77,7 +78,7 @@ Sponsor
.. |Try CodeStream| image:: https://alt-images.codestream.com/codestream_logo_sanicorg.png
:target: https://codestream.com/?utm_source=github&utm_campaign=sanicorg&utm_medium=banner
:alt: Try CodeStream
Manage pull requests and conduct code reviews in your IDE with full source-tree context. Comment on any line, not just the diffs. Use jump-to-definition, your favorite keybindings, and code intelligence with more of your workflow.
`Learn More <https://codestream.com/?utm_source=github&amp;utm_campaign=sanicorg&amp;utm_medium=banner>`_

5
docs/index.rst
View File

@ -1,6 +1,6 @@
.. include:: sanic/index.rst
.. include:: ../README.rst
Guides
API
======
.. toctree::
@ -16,4 +16,3 @@ Module Documentation
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

30
docs/sanic/index.rst
View File

@ -1,30 +0,0 @@
Sanic
=================================
Sanic is a Python 3.6+ web server and web framework that's written to go fast. It allows the usage of the async/await syntax added in Python 3.5, which makes your code non-blocking and speedy.
The goal of the project is to provide a simple way to get up and running a highly performant HTTP server that is easy to build, to expand, and ultimately to scale.
Sanic is developed `on GitHub <https://github.com/channelcat/sanic/>`_. Contributions are welcome!
Sanic aspires to be simple
---------------------------
.. code:: python
from sanic import Sanic
from sanic.response import json
app = Sanic("App Name")
@app.route("/")
async def test(request):
return json({"hello": "world"})
if __name__ == "__main__":
app.run(host="0.0.0.0", port=8000)
.. note::
Sanic does not support Python 3.5 from version 19.6 and forward. However, version 18.12LTS is supported thru
December 2020. Official Python support for version 3.5 is set to expire in September 2020.