mirror of
https://github.com/Rapptz/discord.py.git
synced 2025-09-06 01:46:08 +00:00
First pass at documentation reform.
This commit is contained in:
@ -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
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
Additional Information
|
||||
-----------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
discord
|
||||
faq
|
||||
whats_new
|
||||
|
||||
If you still can't find what you're looking for, try in one of the following pages:
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
|
Reference in New Issue
Block a user