aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorRapptz <[email protected]>2019-06-28 01:43:04 -0400
committerRapptz <[email protected]>2019-06-28 01:43:04 -0400
commit7543328fe784c5c044f3c814ead271f89ecfb830 (patch)
tree15e0b39df6da6cb4cc58cad9c0ca89e028c23c21 /docs
parentVersion bump to 1.2.3 (diff)
downloaddiscord.py-7543328fe784c5c044f3c814ead271f89ecfb830.tar.xz
discord.py-7543328fe784c5c044f3c814ead271f89ecfb830.zip
Update Sphinx to 2.1.2
Diffstat (limited to 'docs')
-rw-r--r--docs/_static/style.css11
-rw-r--r--docs/api.rst40
-rw-r--r--docs/conf.py2
-rw-r--r--docs/ext/commands/api.rst4
4 files changed, 36 insertions, 21 deletions
diff --git a/docs/_static/style.css b/docs/_static/style.css
index 81166de4..48dbac12 100644
--- a/docs/_static/style.css
+++ b/docs/_static/style.css
@@ -291,6 +291,17 @@ dl.field-list > dt {
font-weight: bold;
}
+/* remove flex from field lists */
+dl.field-list {
+ display: block;
+}
+
+/* internal references are forced to bold for some reason */
+a.reference.internal > strong {
+ font-weight: unset;
+ font-family: monospace;
+}
+
div.danger, div.error {
background-color: #ffe4e4;
border: 1px solid #f66;
diff --git a/docs/api.rst b/docs/api.rst
index ac9c489c..c80bc304 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -1562,14 +1562,16 @@ Certain utilities make working with async iterators easier, detailed below.
Iterates over the contents of the async iterator.
- .. comethod:: next()
+ .. method:: next()
+ :async:
|coro|
Advances the iterator by one, if possible. If no more items are found
then this raises :exc:`NoMoreItems`.
- .. comethod:: get(**attrs)
+ .. method:: get(**attrs)
+ :async:
|coro|
@@ -1579,7 +1581,8 @@ Certain utilities make working with async iterators easier, detailed below.
msg = await channel.history().get(author__name='Dave')
- .. comethod:: find(predicate)
+ .. method:: find(predicate)
+ :async:
|coro|
@@ -1598,7 +1601,8 @@ Certain utilities make working with async iterators easier, detailed below.
:param predicate: The predicate to use. Could be a |coroutine_link|_.
:return: The first element that returns ``True`` for the predicate or ``None``.
- .. comethod:: flatten()
+ .. method:: flatten()
+ :async:
|coro|
@@ -2009,10 +2013,10 @@ module, others which are not.
:members:
:exclude-members: history, typing
- .. autocomethod:: discord.abc.Messageable.history
+ .. automethod:: discord.abc.Messageable.history
:async-for:
- .. autocomethod:: discord.abc.Messageable.typing
+ .. automethod:: discord.abc.Messageable.typing
:async-with:
.. autoclass:: discord.abc.Connectable
@@ -2065,10 +2069,10 @@ User
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: history
+ .. automethod:: history
:async-for:
- .. autocomethod:: typing
+ .. automethod:: typing
:async-with:
Attachment
@@ -2096,7 +2100,7 @@ Reaction
:members:
:exclude-members: users
- .. autocomethod:: users
+ .. automethod:: users
:async-for:
CallMessage
@@ -2118,7 +2122,7 @@ Guild
:members:
:exclude-members: audit_logs
- .. autocomethod:: audit_logs
+ .. automethod:: audit_logs
:async-for:
Member
@@ -2129,10 +2133,10 @@ Member
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: history
+ .. automethod:: history
:async-for:
- .. autocomethod:: typing
+ .. automethod:: typing
:async-with:
Spotify
@@ -2173,10 +2177,10 @@ TextChannel
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: history
+ .. automethod:: history
:async-for:
- .. autocomethod:: typing
+ .. automethod:: typing
:async-with:
VoiceChannel
@@ -2201,10 +2205,10 @@ DMChannel
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: history
+ .. automethod:: history
:async-for:
- .. autocomethod:: typing
+ .. automethod:: typing
:async-with:
GroupChannel
@@ -2215,10 +2219,10 @@ GroupChannel
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: history
+ .. automethod:: history
:async-for:
- .. autocomethod:: typing
+ .. automethod:: typing
:async-with:
PartialInviteGuild
diff --git a/docs/conf.py b/docs/conf.py
index 67b88833..5f0e7592 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -35,7 +35,7 @@ extensions = [
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon',
- 'sphinxcontrib.asyncio',
+ 'sphinxcontrib_trio',
'details',
'exception_hierarchy'
]
diff --git a/docs/ext/commands/api.rst b/docs/ext/commands/api.rst
index a33c31bc..71efb2b5 100644
--- a/docs/ext/commands/api.rst
+++ b/docs/ext/commands/api.rst
@@ -150,10 +150,10 @@ Context
:inherited-members:
:exclude-members: history, typing
- .. autocomethod:: discord.ext.commands.Context.history
+ .. automethod:: discord.ext.commands.Context.history
:async-for:
- .. autocomethod:: discord.ext.commands.Context.typing
+ .. automethod:: discord.ext.commands.Context.typing
:async-with:
.. _ext_commands_api_converters: