https://github.com/asyncio-docs/asyncio-doc

Asyncio documentation
https://github.com/asyncio-docs/asyncio-doc

Last synced: about 1 month ago
JSON representation

Asyncio documentation

• Host: GitHub
• URL: https://github.com/asyncio-docs/asyncio-doc
• Owner: asyncio-docs
• License: cc-by-sa-4.0
• Archived: true
• Created: 2016-07-21T14:57:08.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2021-05-31T07:57:00.000Z (over 3 years ago)
• Last Synced: 2024-04-15T00:05:35.956Z (5 months ago)
• Language: Python
• Homepage: http://asyncio.readthedocs.io/
• Size: 103 KB
• Stars: 196
• Watchers: 14
• Forks: 27
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - asyncio-doc - Asyncio documentation (Python)

README

        
Asyncio documentation

=====================

* Online doc: https://asyncio.readthedocs.io/

* GitHub: https://github.com/asyncio-docs/asyncio-doc

* AsyncIO documentation is written with `Sphinx `_.

Notes to writers

================

Tutorials should use Python 3.5 ``async`` and ``await`` keywords rather than

``@asyncio.coroutine`` and ``yield from``.

Ideas

=====

* Advanced section:

  - protocols and transports: as least point to good implementations

  - explain how to *test* asyncio applications. `Twisted documentation example

    `_

How to install Sphinx

=====================

Firstly, you need to install the Sphinx tool using the Linux package manager

like apt-get or dnf for example.

But if you want to install it via `pip `_ , you

can create a virtual environment with the `venv` module of Python 3 ::

    python3 -m venv env

    source env/bin/activate

    pip install -r requirements.txt

Once you have installed Sphinx, you can build the documentation.

How to build the documentation

==============================

Install Sphinx using the Linux package manager like apt-get or dnf for example.

Then build the documentation using::

    make html

See also

========

* https://docs.python.org/3/library/asyncio.html

* http://krondo.com/an-introduction-to-asynchronous-programming-and-twisted/

* https://curio.readthedocs.io/en/latest/tutorial.html

License

=======

All of the code examples in this site are licensed under the `Creative Commons Zero

(CC0) `_ license.

All other content of this site is licensed under the `Creative Commons Attribution

Share Alike 4.0 (CC-BY-SA) `_ license.