[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

docs/conf.py

@@ -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.

docs/framework_bot.rst

@@ -0,0 +1,19 @@
+.. bot module docs
+
+===
+Bot
+===
+
+.. automodule:: redbot.core.bot
+
+RedBase
+^^^^^^^
+
+.. autoclass:: RedBase
+    :members:
+
+Red
+^^^
+
+.. autoclass:: Red
+    :members:

docs/framework_rpc.rst

@@ -0,0 +1,8 @@
+.. rpc docs
+
+===
+RPC
+===
+
+.. automodule:: redbot.core.rpc
+    :members:

docs/framework_utils.rst

@@ -10,6 +10,12 @@ Chat Formatting
 .. automodule:: redbot.core.utils.chat_formatting
     :members:
 
+Embed Helpers
+=============
+
+.. automodule:: redbot.core.utils.embed
+    :members:
+
 Mod Helpers
 ===========
 

docs/index.rst

@@ -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
 
 

redbot/core/bank.py

@@ -7,10 +7,9 @@ import discord
 from redbot.core import Config
 
 __all__ = ["Account", "get_balance", "set_balance", "withdraw_credits", "deposit_credits",
-           "can_spend", "transfer_credits", "wipe_bank", "get_guild_accounts",
+           "can_spend", "transfer_credits", "wipe_bank", "get_account", "is_global",
-           "get_global_accounts", "get_account", "is_global", "set_global",
+           "set_global", "get_bank_name", "set_bank_name", "get_currency_name",
-           "get_bank_name", "set_bank_name", "get_currency_name", "set_currency_name",
+           "set_currency_name", "get_default_balance", "set_default_balance"]
-           "get_default_balance", "set_default_balance"]
 
 _DEFAULT_GLOBAL = {
     "is_global": False,

redbot/core/rpc.py

@@ -35,7 +35,9 @@ def add_topic(topic_name: str):
     """
     Adds a topic for clients to listen to.
 
-    :param topic_name:
+    Parameters
+    ----------
+    topic_name
     """
     _rpc.add_topics(topic_name)
 
@@ -50,8 +52,10 @@ def notify(topic_name: str, data: JsonSerializable):
 
         This method will fail silently.
 
-    :param topic_name:
+    Parameters
-    :param data:
+    ----------
+    topic_name
+    data
     """
     _rpc.notify(topic_name, data)
 
@@ -67,10 +71,11 @@ def add_method(prefix, method):
 
         This method will fail silently.
 
-    :param prefix:
+    Parameters
-    :param method:
+    ----------
+    prefix
+    method
         MUST BE A COROUTINE OR OBJECT.
-    :return:
     """
     _rpc.add_methods(
         ('', method),