mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-12-05 17:02:32 -05:00
[V3 Docs] Add and update existing features (#1451)
* [V3 Docs] bump version * Remove removed functions from __all__ * Update docstring format * Update copyright year * Add embed utils docs * Document bot class * Document RPC * Update toctree
This commit is contained in:
@@ -55,7 +55,7 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = 'Red - Discord Bot'
|
||||
copyright = '2017, Cog Creators'
|
||||
copyright = '2018, Cog Creators'
|
||||
author = 'Cog Creators'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
@@ -63,9 +63,9 @@ author = 'Cog Creators'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '3.0.0a1'
|
||||
version = '3.0.0b10'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '3.0.0a1'
|
||||
release = '3.0.0b10'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
19
docs/framework_bot.rst
Normal file
19
docs/framework_bot.rst
Normal file
@@ -0,0 +1,19 @@
|
||||
.. bot module docs
|
||||
|
||||
===
|
||||
Bot
|
||||
===
|
||||
|
||||
.. automodule:: redbot.core.bot
|
||||
|
||||
RedBase
|
||||
^^^^^^^
|
||||
|
||||
.. autoclass:: RedBase
|
||||
:members:
|
||||
|
||||
Red
|
||||
^^^
|
||||
|
||||
.. autoclass:: Red
|
||||
:members:
|
||||
8
docs/framework_rpc.rst
Normal file
8
docs/framework_rpc.rst
Normal file
@@ -0,0 +1,8 @@
|
||||
.. rpc docs
|
||||
|
||||
===
|
||||
RPC
|
||||
===
|
||||
|
||||
.. automodule:: redbot.core.rpc
|
||||
:members:
|
||||
@@ -10,6 +10,12 @@ Chat Formatting
|
||||
.. automodule:: redbot.core.utils.chat_formatting
|
||||
:members:
|
||||
|
||||
Embed Helpers
|
||||
=============
|
||||
|
||||
.. automodule:: redbot.core.utils.embed
|
||||
:members:
|
||||
|
||||
Mod Helpers
|
||||
===========
|
||||
|
||||
|
||||
@@ -30,13 +30,16 @@ Welcome to Red - Discord Bot's documentation!
|
||||
guide_migration
|
||||
guide_cog_creation
|
||||
framework_bank
|
||||
framework_bot
|
||||
framework_cogmanager
|
||||
framework_datamanager
|
||||
framework_config
|
||||
framework_context
|
||||
framework_datamanager
|
||||
framework_downloader
|
||||
framework_events
|
||||
framework_i18n
|
||||
framework_modlog
|
||||
framework_context
|
||||
framework_rpc
|
||||
framework_utils
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user