mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-20 18:06:08 -05:00
[V3 Docs] Remove all build warnings (#1640)
* Upgrade sphinx version to 1.7+ * Fix title overlines/underlines in autostart_systemd.rst * Skip trying to document a method from discord.py * Add escaped space after backtick * Escape underscores (sphinx tries to interpret a hyperlink) * Use fully qualified reference for class * Fix reference in tunnel.py * Remove python syntax highlighting in data_converter.py For some reason sphinx couldn't lex these as python. Removing the highlighting seems like the logical solution for now, since if it wasn't being lexed, it wouldn't highlight anyway. * Comment out static path since we're not using it right now * Update sphinx version in docs requirements too Would rather remove this duplication but RTD is a special snowflake
This commit is contained in:
@@ -47,15 +47,11 @@ class DataConverter:
|
||||
This should be a function which takes a single argument argument
|
||||
(the loaded JSON) and from it either
|
||||
returns or yields one or more `dict`
|
||||
whose items are in the form:
|
||||
|
||||
.. code-block:: python
|
||||
whose items are in the form::
|
||||
|
||||
{(SCOPE, *IDENTIFIERS): {(key_tuple): value}}
|
||||
|
||||
an example of a possible entry of that dict:
|
||||
|
||||
.. code-block:: python
|
||||
an example of a possible entry of that dict::
|
||||
|
||||
{(Config.MEMBER, '133049272517001216', '78631113035100160'):
|
||||
{('balance',): 9001}}
|
||||
@@ -100,15 +96,11 @@ class DataConverter:
|
||||
This should be a dictionary of values to set.
|
||||
This is provided as an alternative
|
||||
to providing a file and conversion specification
|
||||
the dictionary should be in the following format
|
||||
|
||||
.. code-block:: python
|
||||
the dictionary should be in the following format::
|
||||
|
||||
{(SCOPE, *IDENTIFIERS): {(key_tuple): value}}`
|
||||
|
||||
an example of a possible entry of that dict:
|
||||
|
||||
.. code-block:: python
|
||||
an example of a possible entry of that dict::
|
||||
|
||||
{(Config.MEMBER, '133049272517001216', '78631113035100160'):
|
||||
{('balance',): 9001}}
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Original source of reaction-based menu idea from
|
||||
https://github.com/Lunar-Dust/Dusty-Cogs/blob/master/menu/menu.py
|
||||
|
||||
Ported to Red V3 by Palm__ (https://github.com/palmtree5)
|
||||
Ported to Red V3 by Palm\_\_ (https://github.com/palmtree5)
|
||||
"""
|
||||
import asyncio
|
||||
import discord
|
||||
|
||||
@@ -112,13 +112,13 @@ class Tunnel(metaclass=TunnelMeta):
|
||||
The message content
|
||||
embed: `discord.Embed`
|
||||
The embed to send
|
||||
files: `List[discord.Files]`
|
||||
files: `list` of `discord.File`
|
||||
A list of files to send.
|
||||
|
||||
|
||||
Returns
|
||||
-------
|
||||
list of `discord.Message`
|
||||
The `discord.Message`(s) sent as a result
|
||||
The `discord.Message`\ (s) sent as a result
|
||||
|
||||
Raises
|
||||
------
|
||||
|
||||
Reference in New Issue
Block a user