summaryrefslogtreecommitdiffstats
path: root/docs/source/contributing/index.md
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2021-12-12 15:29:41 +0000
committerCalum Lind <calumlind+deluge@gmail.com>2021-12-12 18:16:21 +0000
commit24aa48187e3dd34daf5d4cb8c7d01c839141c9b7 (patch)
tree40a3d5d87f91892b072884b3486242b326899224 /docs/source/contributing/index.md
parent342cca436766febd122aaf94395355ec4baff894 (diff)
downloaddeluge-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/contributing/index.md')
-rw-r--r--docs/source/contributing/index.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/source/contributing/index.md b/docs/source/contributing/index.md
index afdead24d..8c07a76b1 100644
--- a/docs/source/contributing/index.md
+++ b/docs/source/contributing/index.md
@@ -3,7 +3,11 @@
Deluge is an open-source project, and relies on its community of users to keep
getting better.
-- [Code contributions](code.md)
-- [Running tests](testing.md)
-- [Documentation contributions](documentation.md)
-- [Translation contributions](translations.md)
+```{toctree}
+:titlesonly:
+
+code
+testing
+documentation
+translations
+```