diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index dc00d10ce..0ebf776bc 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,3 +13,6 @@ core/sentry_setup.py @Kowlin @tekulvw cogs/alias/* @tekulvw cogs/downloader/* @tekulvw cogs/general/* @palmtree5 + +# Docs +docs/* @tekulvw @palmtree5 diff --git a/README.rst b/README.rst index 4120eca4d..98f603da2 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,27 @@ -[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) +.. image:: https://readthedocs.org/projects/red-discordbot/badge/?version=v3-develop + :target: http://red-discordbot.readthedocs.io/en/v3-develop/?badge=v3-develop + :alt: Documentation Status -## Red - Discord Bot v3 +.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square + :target: http://makeapullrequest.com + :alt: PRs Welcome + +******************** +Red - Discord Bot v3 +******************** **This is alpha and very much a work in progress. Regular use is not recommended. There will not be any effort not to break current installations.** -### How to install +How to install +^^^^^^^^^^^^^^ Using python3 pip:: pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop redbot-setup redbot + +To install all requirements for docs and tests:: + + pip install --process-dependency-links -U git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[tests,docs] diff --git a/docs/cog_downloader.rst b/docs/cog_downloader.rst index 84f04c4d7..dfb4bdd85 100644 --- a/docs/cog_downloader.rst +++ b/docs/cog_downloader.rst @@ -3,7 +3,7 @@ Downloader Cog Reference ======================== -.. automodule:: cogs.downloader +.. automodule:: redbot.cogs.downloader -.. autoclass:: cogs.downloader.downloader.Downloader +.. autoclass:: redbot.cogs.downloader.downloader.Downloader :members: diff --git a/docs/framework_bank.rst b/docs/framework_bank.rst index 5cb50e629..3ddbf89e3 100644 --- a/docs/framework_bank.rst +++ b/docs/framework_bank.rst @@ -38,5 +38,5 @@ API Reference Bank ====== -.. automodule:: core.bank +.. automodule:: redbot.core.bank :members: diff --git a/docs/framework_cogmanager.rst b/docs/framework_cogmanager.rst index 0cb3e7e9d..af094f136 100644 --- a/docs/framework_cogmanager.rst +++ b/docs/framework_cogmanager.rst @@ -4,5 +4,5 @@ Cog Manager =========== -.. automodule:: core.cog_manager +.. automodule:: redbot.core.cog_manager :members: diff --git a/docs/framework_config.rst b/docs/framework_config.rst index a17379236..d982ef211 100644 --- a/docs/framework_config.rst +++ b/docs/framework_config.rst @@ -35,7 +35,7 @@ Basic Usage Tutorial ******** -.. py:currentmodule:: core.config +.. py:currentmodule:: redbot.core.config This tutorial will walk you through how to use Config. @@ -157,7 +157,7 @@ API Reference inside the bot itself! Simply take a peek inside of the :code:`tests/core/test_config.py` file for examples of using Config in all kinds of ways. -.. automodule:: core.config +.. automodule:: redbot.core.config Config ^^^^^^ @@ -190,7 +190,7 @@ Value Driver Reference **************** -.. automodule:: core.drivers +.. automodule:: redbot.core.drivers .. autoclass:: red_base.BaseDriver :members: diff --git a/docs/framework_downloader.rst b/docs/framework_downloader.rst index 64c113b17..4f722027f 100644 --- a/docs/framework_downloader.rst +++ b/docs/framework_downloader.rst @@ -41,12 +41,12 @@ KEYS (case sensitive): API Reference ************* -.. automodule:: cogs.downloader.json_mixins +.. automodule:: redbot.cogs.downloader.json_mixins .. autoclass RepoJSONMixin :members -.. automodule:: cogs.downloader.installable +.. automodule:: redbot.cogs.downloader.installable Installable ^^^^^^^^^^^ @@ -54,7 +54,7 @@ Installable .. autoclass:: Installable :members: -.. automodule:: cogs.downloader.repo_manager +.. automodule:: redbot.cogs.downloader.repo_manager Repo ^^^^ @@ -71,6 +71,6 @@ Repo Manager Exceptions ^^^^^^^^^^ -.. automodule:: cogs.downloader.errors +.. automodule:: redbot.cogs.downloader.errors :members: