Red-DiscordBot/docs/index.rst
jack1142 560e0f7334
Add docs for updating Red (#3790)
* wip

* Add 3.0.2 or older instructions

* rephrase

* emphasis

* another rephrase

* Add 3.2.0+ instructions for Linux & Mac

* change indents
2020-04-26 19:35:59 +02:00

79 lines
1.4 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
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
.. toctree::
:maxdepth: 2
:caption: Red Development Framework Reference:
guide_migration
guide_cog_creation
guide_publish_cogs
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_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`