diff options
| author | Rapptz <[email protected]> | 2017-05-12 20:14:34 -0400 |
|---|---|---|
| committer | Rapptz <[email protected]> | 2017-05-12 20:14:34 -0400 |
| commit | b44bba6ee6e29b38d1e579c602821582e155ec3b (patch) | |
| tree | 355df44874b3e5f8ee4e825339cb57783e3677ca /docs/index.rst | |
| parent | Rename abc.Callable to abc.Connectable. (diff) | |
| download | discord.py-b44bba6ee6e29b38d1e579c602821582e155ec3b.tar.xz discord.py-b44bba6ee6e29b38d1e579c602821582e155ec3b.zip | |
First pass at documentation reform.
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 48 |
1 files changed, 40 insertions, 8 deletions
diff --git a/docs/index.rst b/docs/index.rst index 30a41468..883d0146 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,23 +3,55 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to discord.py's documentation! -====================================== +Welcome to the discord.py documentation +========================================= -Contents: +.. image:: /images/snake.png + +discord.py is a modern, easy to use, feature-rich, and async ready API wrapper +for Discord. + +**Features:** + +- Modern Pythonic API using ``async``\/``await`` syntax +- Sane rate limit handling that prevents 429s +- Implements the entirety of the Discord API +- Command extension to aid with bot creation +- Easy to use with an object oriented design +- Optimised for both speed and memory + +Documentation Contents +----------------------- .. toctree:: :maxdepth: 2 - logging - whats_new + intro + quickstart migrating + logging api - faq +Extensions +----------- + +.. toctree:: + :maxdepth: 2 + + ext/commands/index.rst + + +Additional Information +----------------------- + +.. toctree:: + :maxdepth: 2 + + discord + faq + whats_new -Indices and tables -================== +If you still can't find what you're looking for, try in one of the following pages: * :ref:`genindex` * :ref:`modindex` |