deluge/docs/source/devguide/index.md

# Development guide

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)
[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.`

			`- [Tutorials](tutorials/index.md)`
[Docs] Cleanup changelog and docs 2019-06-05 23:32:37 +01:00			`- [How-to guides](how-to/index.md)`
[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			`- [Packaging](packaging/index.md)`
[Docs] Add release notes and update pages 2019-06-08 16:42:25 +01:00			`- [Changelog](../changelog.md)`