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/devguide/index.md | |
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/devguide/index.md')
-rw-r--r-- | docs/source/devguide/index.md | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/docs/source/devguide/index.md b/docs/source/devguide/index.md index bde04b3e0..436a72a11 100644 --- a/docs/source/devguide/index.md +++ b/docs/source/devguide/index.md @@ -2,7 +2,12 @@ This is a guide to help with developing Deluge. -- [Tutorials](tutorials/index.md) -- [How-to guides](how-to/index.md) -- [Packaging](packaging/index.md) -- [Changelog](../changelog.md) +```{toctree} +:titlesonly: + +Tutorials <tutorials/index> +how-to/index +Packaging <packaging/index> +../changelog +../depends +``` |