diff --git a/docs/index.md b/docs/index.md index c6b30a7..dc27039 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ This project originates from a scrapped PEP. For the original text, see [here](https://gist.github.com/ZeroIntensity/8d32e94b243529c7e1c27349e972d926). -## Motivation +## Introduction CPython currently has no existing C interface for writing asynchronous functions or doing any sort of `await` operations, other than defining extension types and manually implementing methods like `__await__` from scratch. This lack of an API can be seen in some Python-to-C transpilers (such as `mypyc`) having limited support for asynchronous code. @@ -14,8 +14,6 @@ In the C API, developers are forced to do one of three things when it comes to a - Use an external tool to compile their asynchronous code to C. - Defer their asynchronous logic to a synchronous Python function, and then call that natively. -## Introduction - Since there are other event loop implementations, PyAwaitable aims to be a _generic_ interface for working with asynchronous operations from C (as in, we'll only be implementing features like `async def` and `await`, but not things like `asyncio.create_task`.) This documentation assumes that you're familiar with the C API already, and understand some essential concepts like reference counting (as well as borrowed and strong references). If you don't know what any of that means, it's highly advised that you read through the [Python docs](https://docs.python.org/3/extending/extending.html) before trying to use PyAwaitable. diff --git a/netlify.toml b/netlify.toml index 2f38440..c0edb5b 100644 --- a/netlify.toml +++ b/netlify.toml @@ -1,4 +1,4 @@ [build] command = "mkdocs build" publish = "site" -ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF ./docs" \ No newline at end of file +ignore = "git diff --quiet $CACHED_COMMIT_REF $COMMIT_REF docs/"