deluge/docs/source/index.rst

Deluge Documentation
====================

Contents
--------

.. toctree::
   :maxdepth: 2

   Contributing <contributing/index.md>
   Developer Guide <devguide/index.md>
   Reference <reference/index.rst>

* :ref:`genindex`
* :ref:`modindex`
[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			`Deluge Documentation`
			`====================`
Initial support for sphinx documentation. Still need to create rst files for the modules. To build docs, goto docs/ folder and type `sphinx-build source html` 2008-11-05 03:14:45 +00:00
[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			`Contents`
			`--------`
Initial support for sphinx documentation. Still need to create rst files for the modules. To build docs, goto docs/ folder and type `sphinx-build source html` 2008-11-05 03:14:45 +00:00
			`.. toctree::`
			`:maxdepth: 2`
Fix building the code documentation with sphinx Updated Sphinx conf and tested with Sphinx 1.2.1 Moved webui gen_gettext script Fixed docstring warning in code Renamed console update-tracker to update_tracker 2014-02-20 17:24:11 +00:00
[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			`Contributing <contributing/index.md>`
			`Developer Guide <devguide/index.md>`
			`Reference <reference/index.rst>`
Initial support for sphinx documentation. Still need to create rst files for the modules. To build docs, goto docs/ folder and type `sphinx-build source html` 2008-11-05 03:14:45 +00:00
			* :ref:`genindex`
			* :ref:`modindex`