diff options
author | Calum Lind <calumlind+deluge@gmail.com> | 2021-12-12 15:29:41 +0000 |
---|---|---|
committer | Calum Lind <calumlind+deluge@gmail.com> | 2021-12-12 18:16:21 +0000 |
commit | 24aa48187e3dd34daf5d4cb8c7d01c839141c9b7 (patch) | |
tree | 40a3d5d87f91892b072884b3486242b326899224 /docs/source/how-to | |
parent | 342cca436766febd122aaf94395355ec4baff894 (diff) | |
download | deluge-24aa48187e3dd34daf5d4cb8c7d01c839141c9b7.tar.gz deluge-24aa48187e3dd34daf5d4cb8c7d01c839141c9b7.tar.bz2 deluge-24aa48187e3dd34daf5d4cb8c7d01c839141c9b7.zip |
[Docs] Replace recommonmark with MyST parser
We used recommonmark so that we can use markdown in sphinx but it is
buggy and now so switch to better supported MyST-parser.
* Fixed incorrect heading warnings in markdown.
* Added sphinx toctree to markdown using directive as required by MyST.
* Upgraded Sphinx to 4.3
Ref: https://myst-parser.readthedocs.io
Diffstat (limited to 'docs/source/how-to')
-rw-r--r-- | docs/source/how-to/index.md | 16 | ||||
-rw-r--r-- | docs/source/how-to/launchd-service.md | 4 | ||||
-rw-r--r-- | docs/source/how-to/systemd-service.md | 8 |
3 files changed, 18 insertions, 10 deletions
diff --git a/docs/source/how-to/index.md b/docs/source/how-to/index.md index 9ef1ddde6..7005a3414 100644 --- a/docs/source/how-to/index.md +++ b/docs/source/how-to/index.md @@ -4,7 +4,11 @@ A collection of guides covering common issues that might be encountered using De ## GTK UI -- [Set default torrent application](set-mime-type.md) +```{toctree} +:titlesonly: + +Set default torrent application <set-mime-type> +``` ## Deluge as a service @@ -14,6 +18,10 @@ shutdown and automatically restart them if they crash. The Deluge daemon deluged and Web UI deluge-web can both be run as services. -- [Create systemd services for Linux](systemd-service.md) -- [Create launchd services for macOS](launchd-service.md) -- [Create NSSM services for Windows](nssm-service.md) +```{toctree} +:titlesonly: + +Create systemd services for Linux <systemd-service> +Create launchd services for macOS <launchd-service> +Create NSSM services for Windows <nssm-service> +``` diff --git a/docs/source/how-to/launchd-service.md b/docs/source/how-to/launchd-service.md index b988a19e3..53c21bef5 100644 --- a/docs/source/how-to/launchd-service.md +++ b/docs/source/how-to/launchd-service.md @@ -12,7 +12,7 @@ and will need modified if using other installation methods e.g. `Deluge.app`. Create the file `/Library/LaunchDaemons/org.deluge-torrent.deluged.plist` containing the following: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/osx/launchd/org.deluge-torrent.deluged.plist :language: xml ``` @@ -29,7 +29,7 @@ sudo launchctl start org.deluge-torrent.deluged Create the file `/Library/LaunchDaemons/org.deluge-torrent.deluge-web.plist` containing the following: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/osx/launchd/org.deluge-torrent.deluge-web.plist :language: xml ``` diff --git a/docs/source/how-to/systemd-service.md b/docs/source/how-to/systemd-service.md index 8c7ac01e8..611ecc13d 100644 --- a/docs/source/how-to/systemd-service.md +++ b/docs/source/how-to/systemd-service.md @@ -30,7 +30,7 @@ sudo adduser <username> deluge Create the file `/etc/systemd/system/deluged.service` containing the following: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/systemd/deluged.service :language: ini ``` @@ -47,7 +47,7 @@ sudo mkdir /etc/systemd/system/deluged.service.d/ Then create a user file `/etc/systemd/system/deluged.service.d/user.conf` with the following contents: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/systemd/user.conf :language: ini ``` @@ -82,7 +82,7 @@ after changes. Create the file `/etc/systemd/system/deluge-web.service` containing the following: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/systemd/deluge-web.service :language: ini ``` @@ -99,7 +99,7 @@ sudo mkdir /etc/systemd/system/deluge-web.service.d/ Then create a user file `/etc/systemd/system/deluge-web.service.d/user.conf` with the following contents: -```eval_rst +```{eval-rst} .. literalinclude:: ../../../packaging/systemd/user.conf :language: ini ``` |