deluge/docs/source/devguide/index.md

# Development guide

This is a guide to help with developing Deluge.

```{toctree}
:titlesonly:

Tutorials <tutorials/index>
how-to/index
Packaging <packaging/index>
../changelog
../depends
```
[Docs] Cleanup changelog and docs 2019-06-05 23:32:37 +01:00			`# Development guide`
[Docs] Reorganise and add sections from wiki - Change the layout and contents of docs to be better organised and follow ideas from: https://www.divio.com/blog/documentation/ - Use markdown for non-technical documents to speed up writing. - Added new sections and imported documents from Trac wiki. Build fixes: - Added a patch to fix recommonmark 0.4 and doc referencing: https://github.com/rtfd/recommonmark/issues/93 - Set docs build in tox to Py2.7 since there are problems with autodoc mocking multiple inheritance on Python 3 resulting in metaclass errors. - Supressed warning about `modules.rst` not in the toctree by creating a static `modules.rst` with `:orphan:` file directive and add to git. Also skip creating this toc file with sphinx-apidoc in setup and tox. - Simplified finding exported RPC and JSON API methods by adding an autodoc custom class directive. Removed unneeded __rpcapi.py. 2018-10-05 09:33:26 +01:00
			`This is a guide to help with developing Deluge.`

[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 2021-12-12 15:29:41 +00:00			```{toctree}
			`:titlesonly:`

			`Tutorials <tutorials/index>`
			`how-to/index`
			`Packaging <packaging/index>`
			`../changelog`
			`../depends`
			```