Commit Graph

11 Commits

Author SHA1 Message Date
Calum Lind 82ecf8a416 [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-11-01 17:38:10 +00:00
bendikro 5713ff09f4 [Docs] Autogenerate module docs with apidoc
* Add sphinx-apidoc to setup.py build_docs
2016-05-22 12:11:41 +01:00
Calum Lind 9290cc1f7a 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:38:51 +00:00
Andrew Resch 66bd2e3030 Add sessionproxy.rst 2010-03-28 12:45:51 -07:00
Andrew Resch bd5998ec05 Remove gtkui.rst for the time being 2009-08-12 07:17:21 +00:00
Andrew Resch 5376ae307a Add maketorrent.rst 2009-08-12 00:11:08 +00:00
Andrew Resch c0d0498f36 Add rst files for all the modules 2009-08-11 23:05:13 +00:00
Damien Churchill 0fa403929a update the docs for the ui common module 2009-07-23 00:42:38 +00:00
Damien Churchill 5f89f5239e add autodoc for ui.common
fix some docstrings in the json_api module
2009-07-23 00:24:07 +00:00
Damien Churchill 5ca119827b update documentation about the webui 2009-07-22 23:53:30 +00:00
Damien Churchill c62258fa48 move docs out of the deluge package 2009-07-20 09:02:09 +00:00