CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 11:18:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Fix docs post pip install refactor (#969)

Browse Source 
* Fix downloader

* Fix bank

* Fix cog manager

* Fix config

* Fix readme

* Add docs/test link to readme

* Add docs codeowners
This commit is contained in:
Will 2017-09-08 23:31:32 -04:00 committed by GitHub
parent d69fd63da7
commit 7c3b2673a5
7 changed files with 30 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.github/CODEOWNERS vendored
View File

@ -13,3 +13,6 @@ core/sentry_setup.py @Kowlin @tekulvw
cogs/alias/* @tekulvw
cogs/downloader/* @tekulvw
cogs/general/* @palmtree5
# Docs
docs/* @tekulvw @palmtree5

19
README.rst
View File

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

4
docs/cog_downloader.rst
View File

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

2
docs/framework_bank.rst
View File

@ -38,5 +38,5 @@ API Reference
Bank
======
.. automodule:: core.bank
.. automodule:: redbot.core.bank
:members:

2
docs/framework_cogmanager.rst
View File

@ -4,5 +4,5 @@
Cog Manager
===========
.. automodule:: core.cog_manager
.. automodule:: redbot.core.cog_manager
:members:

6
docs/framework_config.rst
View File

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

8
docs/framework_downloader.rst
View File

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