mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
410b2419dd
* Initial commit * Add some args * bool prolog * index * Add more arguments * more arguments, style fixes * improve naming of arguments * Fix up backlog * Run black * extra corrections from backlog * Update tempban arg names * backlog * change prolog type * Change kick argument prolog to member instead of user * Update argument names * missed a colon * Update prolog to be friendly with non-positional args * Edit through the decorator instead * Add back docstring spacing * black * usage in decorator for name commands * Fix command signature * fixup docstring spacing * style fixes * Add spacing inside unban docstring * Rename args instead of using usage * black - simple * Add labeler glob * unify style * rename variables instead of usage * Update docstrings correspondingly * run black * update description in usage * ehh this isn't necessary... * fix up tags * fix grammar and accuracy issues * fix docstring too
101 lines
1.9 KiB
ReStructuredText
101 lines
1.9 KiB
ReStructuredText
.. Red - Discord Bot documentation master file, created by
|
|
sphinx-quickstart on Thu Aug 10 23:18:25 2017.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
.. _main:
|
|
|
|
Welcome to Red - Discord Bot's documentation!
|
|
=============================================
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Installation Guides:
|
|
|
|
install_windows
|
|
install_linux_mac
|
|
bot_application_guide
|
|
update_red
|
|
about_venv
|
|
autostart_systemd
|
|
autostart_mac
|
|
autostart_pm2
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Cog Reference:
|
|
|
|
cog_customcom
|
|
cog_permissions
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User guides:
|
|
|
|
getting_started
|
|
cog_guides/admin
|
|
cog_guides/alias
|
|
cog_guides/bank
|
|
cog_guides/cleanup
|
|
cog_guides/cog_manager_ui
|
|
cog_guides/core
|
|
cog_guides/customcommands
|
|
cog_guides/downloader
|
|
cog_guides/economy
|
|
cog_guides/filter
|
|
cog_guides/general
|
|
cog_guides/image
|
|
cog_guides/mod
|
|
cog_guides/mutes
|
|
cog_guides/reports
|
|
cog_guides/streams
|
|
cog_guides/trivia
|
|
red_core_data_statement
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Red Development Framework Reference:
|
|
|
|
guide_migration
|
|
guide_cog_creation
|
|
guide_publish_cogs
|
|
guide_cog_creators
|
|
framework_apikeys
|
|
framework_bank
|
|
framework_bot
|
|
framework_checks
|
|
framework_cogmanager
|
|
framework_commands
|
|
framework_config
|
|
framework_datamanager
|
|
framework_events
|
|
framework_i18n
|
|
framework_modlog
|
|
framework_rpc
|
|
framework_utils
|
|
version_guarantees
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Changelogs:
|
|
|
|
changelog_3_4_0
|
|
changelog_3_3_0
|
|
release_notes_3_2_0
|
|
changelog_3_2_0
|
|
changelog_3_1_0
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Others
|
|
|
|
host-list
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|