mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
0eaa0f494c
* Core guide initial commit * Mydata docstrings * Regenerated docs * Lots more docstrings * Add document link * Up to load docstrings * Black formatting * docstring semantics * "cog packages" for loads * Refix line lengths * Regenerate docs * Remove link * Regenerate docs with new code * Some small docstrings * Regenerate docs with new .. warning code * More docstrings into the `set` command * Bullet lists need blank lines. * Regenerate docs * Regenerate docs (fix bullet lists) * set activity statuses docstrings * Docstrings up to helpset pagecharlimit * Regenerate docs * Core guide initial commit * Mydata docstrings * Regenerated docs * Lots more docstrings * Add document link * Up to load docstrings * Black formatting * docstring semantics * "cog packages" for loads * Refix line lengths * Regenerate docs * Remove link * Regenerate docs with new code * Some small docstrings * Regenerate docs with new .. warning code * More docstrings into the `set` command * Bullet lists need blank lines. * Regenerate docs * Regenerate docs (fix bullet lists) * set activity statuses docstrings * Docstrings up to helpset pagecharlimit * Regenerate docs * Maxpages and delete delay docstrings * spagetthi ctrl+v * tagline and contact * A little more contact * Up to allowlist * Up to command defaultdisablecog * Regenerate docs * Redo custominfo to not be terrible * Up to default enabled cog * More docs * Up to command disabledmsg * Disabled message stuff was missed * Finish the rest of the docstrings * Regenerate docs * Longer description of the cog * Regenerate Docs * Fix some of the suggestions * Apply additional suggests and some small rewording. * Regenerate docs. * Apply suggestions and make additional fixes * Regenerate docs * Clarifies it's only loaded. * Regenerate docs. * New formatting, more examples, some fixes * Regenerate docs * Adds consistant use of dashes to arguments * More consistant punctuation * Regenerate docs * Add labeler detection * Fix example and use clearing language for helpset verifyexists docstring * Regenerate docs * Add leave example and arguments * Regenerate docs * Regenerate docs * Make embedset more readable (933aefd3ee9371b3b669cbdd2ac05f6b5532e4bb was the sphinx compatible update) * Regenerate docs * Black formatting * Regenerate docs * Adds docstring examples and arguments for multiple `embedset` subcommands * Regenerate docs
97 lines
1.8 KiB
ReStructuredText
97 lines
1.8 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_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/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`
|