Red-DiscordBot

mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-12-05 08:52:31 -05:00

Go to file

Tobotimus 4637ff78c0 [V3 Docs] Remove all build warnings (#1640 )

* Upgrade sphinx version to 1.7+

* Fix title overlines/underlines in autostart_systemd.rst

* Skip trying to document a method from discord.py

* Add escaped space after backtick

* Escape underscores (sphinx tries to interpret a hyperlink)

* Use fully qualified reference for class

* Fix reference in tunnel.py

* Remove python syntax highlighting in data_converter.py

For some reason sphinx couldn't lex these as python. Removing the highlighting seems like the logical solution for now, since if it wasn't being lexed, it wouldn't highlight anyway.

* Comment out static path since we're not using it right now

* Update sphinx version in docs requirements too

Would rather remove this duplication but RTD is a special snowflake

2018-05-13 20:06:52 -08:00

.github

[V3] move to multiple issue/pr templates (#1585 )

2018-05-04 03:58:30 +02:00

docs

[V3 Docs] Remove all build warnings (#1640 )

2018-05-13 20:06:52 -08:00

redbot

[V3 Docs] Remove all build warnings (#1640 )

2018-05-13 20:06:52 -08:00

tests

[V3 Config] Fix unloading and implement singleton driver (#1458 )

2018-04-02 16:47:27 -08:00

.gitignore

[V3] Add .pytest_cache to .gitignore (#1520 )

2018-04-11 14:45:53 -08:00

.readthedocs.yml

[V3 Docs] Remove all build warnings (#1640 )

2018-05-13 20:06:52 -08:00

.travis.yml

[V3] Splitted deployment stage into their own stages. (#1524 )

2018-04-13 13:16:36 -08:00

crowdin.yml

[V3] add a script for regenerating all strings (#1318 )

2018-02-19 03:02:22 +01:00

generate_strings.py

[V3] add a script for regenerating all strings (#1318 )

2018-02-19 03:02:22 +01:00

LICENSE

[V3] Update year in license (#1242 )

2018-01-09 16:20:05 -09:00

MANIFEST.in

[V3 Audio] Initial V3 addition (#1373 )

2018-03-03 15:42:20 +11:00

README.rst

[V3 Readme] Update Patreon link (#1434 )

2018-03-14 19:22:50 -04:00

requirements.txt

[V3] Update trivia version and allow installing in develop mode (#1635 )

2018-05-13 13:43:16 -08:00

setup.cfg

[V3 Everything] Package bot and write setup scripts (#964 )

2017-09-08 23:14:32 -04:00

setup.py

[V3 Docs] Remove all build warnings (#1640 )

2018-05-13 20:06:52 -08:00

README.rst

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

.. image:: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
    :target: http://makeapullrequest.com
    :alt: PRs Welcome

.. image:: https://d322cqt584bo4o.cloudfront.net/red-discordbot/localized.svg
    :target: https://crowdin.com/project/red-discordbot
    :alt: Crowdin
    
.. image:: https://img.shields.io/badge/Support-Red!-orange.svg
    :target: https://www.patreon.com/Red_Devs
    :alt: Patreon

********************
Red - Discord Bot v3
********************

**This is in beta and very much a work in progress. Regular use is not recommended.
There will not be any effort made to prevent the breaking of current installations.**

How to install
^^^^^^^^^^^^^^

Using python3 pip::

    pip install --process-dependency-links -U Red-DiscordBot
    redbot-setup
    redbot <name>

To install requirements for voice::

    pip install --process-dependency-links -U Red-DiscordBot[voice]

To install all requirements for docs and tests::

    pip install --process-dependency-links -U Red-DiscordBot[test,docs]

For the latest git build, replace ``Red-DiscordBot`` in the above commands with
``git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop``.