mirror of
https://git.deluge-torrent.org/deluge
synced 2025-09-04 09:05:35 +00:00
[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
This commit is contained in:
parent
342cca4367
commit
24aa48187e
15 changed files with 80 additions and 55 deletions
|
@ -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
|
||||
```
|
||||
|
|
|
@ -38,7 +38,7 @@ Running the tests for a specific plugin (requires [pytest](https://pypi.python.o
|
|||
|
||||
All the tests for Deluge can be run using [Tox](https://pypi.python.org/pypi/tox)
|
||||
|
||||
#### See available targets:
|
||||
### See available targets:
|
||||
|
||||
tox -l
|
||||
py27
|
||||
|
@ -46,11 +46,11 @@ All the tests for Deluge can be run using [Tox](https://pypi.python.org/pypi/tox
|
|||
lint
|
||||
docs
|
||||
|
||||
#### Run specific test:
|
||||
### Run specific test:
|
||||
|
||||
tox -e py3
|
||||
|
||||
#### Verify code with pre-commit:
|
||||
### Verify code with pre-commit:
|
||||
|
||||
tox -e lint
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue