mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-21 02:16:09 -05:00
[V3] NumPy Docstrings (#1032)
* ALL THE DOCSTRINGS * Remove imports in drivers package * Fixed build warnings
This commit is contained in:
@@ -37,6 +37,7 @@ extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.viewcode',
|
||||
'sphinx.ext.napoleon',
|
||||
'sphinxcontrib.asyncio'
|
||||
]
|
||||
|
||||
@@ -84,6 +85,9 @@ pygments_style = 'sphinx'
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = False
|
||||
|
||||
# Role which is assigned when you make a simple reference within backticks
|
||||
default_role = "any"
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
|
||||
@@ -192,5 +192,4 @@ Driver Reference
|
||||
|
||||
.. automodule:: redbot.core.drivers
|
||||
|
||||
.. autoclass:: red_base.BaseDriver
|
||||
:members:
|
||||
.. autoclass:: redbot.core.drivers.red_base.BaseDriver
|
||||
|
||||
@@ -27,11 +27,15 @@ Installing Red
|
||||
|
||||
1. Open a command prompt (open Start, search for "command prompt", then click it)
|
||||
2. Run the appropriate command, depending on if you want audio or not
|
||||
|
||||
* No audio: :code:`python -m pip install Red-DiscordBot`
|
||||
* Audio: :code:`python -m pip install Red-DiscordBot[voice]`
|
||||
|
||||
3. Once that has completed, run :code:`redbot-setup` to set up your instance
|
||||
|
||||
* This will set the location where data will be stored, as well as your
|
||||
storage backend and the name of the instance (which will be used for
|
||||
running the bot)
|
||||
|
||||
4. Once done setting up the instance, run :code:`redbot <your instance name>` to run Red.
|
||||
It will walk through the initial setup, asking for your token and a prefix
|
||||
Reference in New Issue
Block a user