CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-20 18:06:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
This commit is contained in:
Tobotimus
2018-05-14 14:06:52 +10:00
committed by palmtree5
parent 501aff41ea
commit 4637ff78c0
10 changed files with 25 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/autostart_systemd.rst
View File

@@ -1,12 +1,12 @@
.. systemd service guide
==========================
==============================================
Setting up auto-restart using systemd on Linux
==========================
==============================================
---------------------------
-------------------------
Creating the service file
---------------------------
-------------------------
Create the new service file:
@@ -33,9 +33,9 @@ Paste the following and replace all instances of :code:`username` with the usern
Save and exit :code:`ctrl + O; enter; ctrl + x`
---------------------------
---------------------------------
Starting and enabling the service
---------------------------
---------------------------------
.. note:: This same file can be used to start as many instances of the bot as you wish, without creating more service files, just start and enable more services and add any bot instance name after the **@**