213 lines
11 KiB
HTML
213 lines
11 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>Welcome to discord.py</title>
|
||
<!-- end extra head -->
|
||
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/basic.css" />
|
||
<link rel="stylesheet" href="_static/style.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/codeblocks.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/icons.css" type="text/css" />
|
||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/custom.js"></script>
|
||
<script src="_static/settings.js"></script>
|
||
<script src="_static/copy.js"></script>
|
||
<script src="_static/sidebar.js"></script>
|
||
<link rel="shortcut icon" href="_static/discord_py_logo.ico"/>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="discord.ext.commands – Bot commands framework" href="ext/commands/index.html" />
|
||
</head>
|
||
<body>
|
||
<div class="main-grid">
|
||
<header class="grid-item">
|
||
<nav>
|
||
<a href="#" class="main-heading">discord.py</a>
|
||
<a href="https://github.com/Rapptz/discord.py" title="GitHub"><span class="material-icons custom-icons">github</span></a>
|
||
<a href="https://discord.gg/TvqYBrGXEm" title="Discord"><span class="material-icons custom-icons">discord</span></a>
|
||
<a href="faq.html" title="FAQ"><span class="material-icons">help_center</span></a>
|
||
<a onclick="mobileSearch.open();" title="Search" id="open-search" class="mobile-only"><span class="material-icons">search</span></a>
|
||
<a onclick="mobileSearch.close();" title="Close" id="close-search" class="mobile-only" hidden><span class="material-icons">close</span></a>
|
||
</nav>
|
||
<nav class="mobile-only">
|
||
<form role="search" class="search" action="search.html" method="get">
|
||
<div class="search-wrapper">
|
||
<input type="search" name="q" placeholder="Search documentation" />
|
||
<button type="submit">
|
||
<span class="material-icons">search</span>
|
||
</button>
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
</header>
|
||
<div class="sub-header grid-item">
|
||
<label for="documentation_select">View Documentation For</label>
|
||
<select id="documentation_select" onchange="window.location = this.value;">
|
||
<option value="#" selected>discord</option>
|
||
<option value="ext/commands/index.html" >discord.ext.commands</option>
|
||
<option value="ext/tasks/index.html" >discord.ext.tasks</option>
|
||
</select>
|
||
<form role="search" class="search" action="search.html" method="get">
|
||
<div class="search-wrapper">
|
||
<input type="search" name="q" placeholder="Search documentation" />
|
||
<button type="submit">
|
||
<span class="material-icons">search</span>
|
||
</button>
|
||
</div>
|
||
</form>
|
||
<a accesskey="S" class="settings" onclick="settingsModal.open();"><span class="material-icons">settings</span></a>
|
||
</div>
|
||
<aside class="grid-item">
|
||
<span id="hamburger-toggle">
|
||
<span class="material-icons">menu</span>
|
||
</span>
|
||
<span id="settings-toggle" class="settings" onclick="settingsModal.open();">
|
||
<span class="material-icons">settings</span>
|
||
</span>
|
||
<div id="sidebar">
|
||
<h3><a href="#">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Welcome to discord.py</a><ul>
|
||
<li><a class="reference internal" href="#getting-started">Getting started</a></li>
|
||
<li><a class="reference internal" href="#getting-help">Getting help</a></li>
|
||
<li><a class="reference internal" href="#extensions">Extensions</a></li>
|
||
<li><a class="reference internal" href="#manuals">Manuals</a></li>
|
||
<li><a class="reference internal" href="#meta">Meta</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</aside>
|
||
<main class="grid-item" role="main">
|
||
|
||
<section id="welcome-to-discord-py">
|
||
<h1>Welcome to discord.py<a class="headerlink" href="#welcome-to-discord-py" title="Permalink to this headline">¶</a></h1>
|
||
<img alt="_images/snake.svg" src="_images/snake.svg" /><img alt="_images/snake_dark.svg" src="_images/snake_dark.svg" /><p>discord.py is a modern, easy to use, feature-rich, and async ready API wrapper
|
||
for Discord.</p>
|
||
<p><strong>Features:</strong></p>
|
||
<ul class="simple">
|
||
<li><p>Modern Pythonic API using <code class="docutils literal notranslate"><span class="pre">async</span></code>/<code class="docutils literal notranslate"><span class="pre">await</span></code> syntax</p></li>
|
||
<li><p>Sane rate limit handling that prevents 429s</p></li>
|
||
<li><p>Command extension to aid with bot creation</p></li>
|
||
<li><p>Easy to use with an object oriented design</p></li>
|
||
<li><p>Optimised for both speed and memory</p></li>
|
||
</ul>
|
||
<section id="getting-started">
|
||
<h2>Getting started<a class="headerlink" href="#getting-started" title="Permalink to this headline">¶</a></h2>
|
||
<p>Is this your first time using the library? This is the place to get started!</p>
|
||
<ul class="simple">
|
||
<li><p><strong>First steps:</strong> <a class="reference internal" href="intro.html"><span class="doc">Introduction</span></a> | <a class="reference internal" href="quickstart.html"><span class="doc">Quickstart</span></a> | <a class="reference internal" href="logging.html"><span class="doc">Setting Up Logging</span></a></p></li>
|
||
<li><p><strong>Working with Discord:</strong> <a class="reference internal" href="discord.html"><span class="doc">Creating a Bot Account</span></a> | <a class="reference internal" href="intents.html"><span class="doc">A Primer to Gateway Intents</span></a></p></li>
|
||
<li><p><strong>Examples:</strong> Many examples are available in the <a class="reference external" href="https://github.com/Rapptz/discord.py/tree/master/examples">repository</a>.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="getting-help">
|
||
<h2>Getting help<a class="headerlink" href="#getting-help" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you’re having trouble with something, these resources might help.</p>
|
||
<ul class="simple">
|
||
<li><p>Try the <a class="reference internal" href="faq.html"><span class="doc">Frequently Asked Questions</span></a> first, it’s got answers to all common questions.</p></li>
|
||
<li><p>Ask us and hang out with us in our <a class="reference external" href="https://discord.gg/TvqYBrGXEm">Discord</a> server.</p></li>
|
||
<li><p>If you’re looking for something specific, try the <a class="reference internal" href="genindex.html"><span class="std std-ref">index</span></a> or <a class="reference internal" href="search.html"><span class="std std-ref">searching</span></a>.</p></li>
|
||
<li><p>Report bugs in the <a class="reference external" href="https://github.com/Rapptz/discord.py/issues">issue tracker</a>.</p></li>
|
||
<li><p>Ask in our <a class="reference external" href="https://github.com/Rapptz/discord.py/discussions">GitHub discussions page</a>.</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="extensions">
|
||
<h2>Extensions<a class="headerlink" href="#extensions" title="Permalink to this headline">¶</a></h2>
|
||
<p>These extensions help you during development when it comes to common tasks.</p>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="ext/commands/index.html"><code class="docutils literal notranslate"><span class="pre">discord.ext.commands</span></code> – Bot commands framework</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ext/tasks/index.html"><code class="docutils literal notranslate"><span class="pre">discord.ext.tasks</span></code> – asyncio.Task helpers</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="manuals">
|
||
<h2>Manuals<a class="headerlink" href="#manuals" title="Permalink to this headline">¶</a></h2>
|
||
<p>These pages go into great detail about everything the API can do.</p>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="api.html">API Reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ext/commands/api.html">discord.ext.commands API Reference</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="ext/tasks/index.html">discord.ext.tasks API Reference</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="meta">
|
||
<h2>Meta<a class="headerlink" href="#meta" title="Permalink to this headline">¶</a></h2>
|
||
<p>If you’re looking for something related to the project itself, it’s here.</p>
|
||
<div class="toctree-wrapper compound">
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="whats_new.html">Changelog</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="version_guarantees.html">Version Guarantees</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="migrating.html">Migrating to v1.0</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</main>
|
||
<footer class="grid-item">
|
||
© Copyright 2015-present, Rapptz.
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
|
||
</footer>
|
||
</div>
|
||
|
||
<div id="settings" class="modal" onclick="if (event.target == this){ settingsModal.close(); }" hidden>
|
||
<div class="modal-content">
|
||
<span class="close" onclick="settingsModal.close();" title="Close">
|
||
<span class="material-icons">close</span>
|
||
</span>
|
||
<h1>Settings</h1>
|
||
|
||
<h2>Font</h2>
|
||
<div class="setting">
|
||
<h3>Use a serif font:
|
||
<label class="toggle"
|
||
title="Use a serif font? Your system font will be used, falling back to serif.">
|
||
<input type="checkbox" name="useSerifFont" onclick="updateSetting(this);">
|
||
<span class="toggle-slider"></span>
|
||
</label>
|
||
</h3>
|
||
</div>
|
||
|
||
<h2>Theme</h2>
|
||
<div class="setting">
|
||
<h3>
|
||
<label class="toggle" title="Set your theme based on your system preferences">
|
||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="automatic" checked>
|
||
</label>
|
||
Automatic
|
||
</h3>
|
||
<h3>
|
||
<label class="toggle" title="Set your theme to light theme">
|
||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="light">
|
||
</label>
|
||
Light
|
||
</h3>
|
||
<h3>
|
||
<label class="toggle" title="Set your theme to dark theme">
|
||
<input type="radio" name="setTheme" onclick="updateSetting(this);" value="dark">
|
||
</label>
|
||
Dark
|
||
</h3>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="to-top" onclick="scrollToTop()" hidden>
|
||
<span><span class="material-icons">arrow_upward</span> to top</span>
|
||
</div>
|
||
|
||
</body>
|
||
</html> |