Use sphinx-prompt extension (#4908)

* Use sphinx-prompt extension

* Update PM2 guide

* Use an actual proper way to run Red with PM2

* Fix pm2 docs

Co-authored-by: Kowlin <Kowlin@users.noreply.github.com>
This commit is contained in:
jack1142
2021-04-03 18:52:11 +02:00
committed by GitHub
parent 0144cbf88b
commit 0becf70b05
8 changed files with 116 additions and 80 deletions

View File

@@ -33,7 +33,7 @@ right-click on it and then click "Run as administrator".
Then run each of the following commands:
.. code-block:: none
.. prompt:: powershell
Set-ExecutionPolicy Bypass -Scope Process -Force
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072
@@ -44,7 +44,7 @@ Then run each of the following commands:
For Audio support, you should also run the following command before exiting:
.. code-block:: none
.. prompt:: powershell
choco upgrade adoptopenjdk11jre -y
@@ -109,13 +109,13 @@ Start with opening a command prompt (open Start, search for "command prompt", th
Then create your virtual environment with the following command
.. code-block:: none
.. prompt:: batch
py -3.8 -m venv "%userprofile%\redenv"
And activate it with the following command
.. code-block:: none
.. prompt:: batch
"%userprofile%\redenv\Scripts\activate.bat"
@@ -138,14 +138,16 @@ Run **one** of the following set of commands, depending on what extras you want
* Normal installation:
.. code-block:: none
.. prompt:: batch
:prompts: (redenv) C:\\>
python -m pip install -U pip setuptools wheel
python -m pip install -U Red-DiscordBot
* With PostgreSQL support:
.. code-block:: none
.. prompt:: batch
:prompts: (redenv) C:\\>
python -m pip install -U pip setuptools wheel
python -m pip install -U Red-DiscordBot[postgres]
@@ -156,7 +158,8 @@ Setting Up and Running Red
After installation, set up your instance with the following command:
.. code-block:: none
.. prompt:: batch
:prompts: (redenv) C:\\>
redbot-setup
@@ -166,7 +169,8 @@ running the bot).
Once done setting up the instance, run the following command to run Red:
.. code-block:: none
.. prompt:: batch
:prompts: (redenv) C:\\>
redbot <your instance name>