diff options
author | Calum Lind <calumlind@gmail.com> | 2018-10-05 09:33:26 +0100 |
---|---|---|
committer | Calum Lind <calumlind@gmail.com> | 2018-11-01 17:38:10 +0000 |
commit | 82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265 (patch) | |
tree | efd52f493583a3c99853d6577660da0695e95fc8 /setup.cfg | |
parent | 9dcd90056d4225f65046fab4ed37a25e9caeda06 (diff) | |
download | deluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.tar.gz deluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.tar.bz2 deluge-82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265.zip |
[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.
Diffstat (limited to 'setup.cfg')
-rw-r--r-- | setup.cfg | 3 |
1 files changed, 2 insertions, 1 deletions
@@ -24,7 +24,8 @@ known_third_party = # Ignore gtk modules, primarily for tox testing. pygtk, gtk, gobject, gtk.gdk, pango, cairo, pangocairo, # Ignore other module dependencies for pre-commit isort. - twisted, OpenSSL, pytest, recommonmark, chardet, pkg_resources, zope, mock + twisted, OpenSSL, pytest, recommonmark, chardet, pkg_resources, zope, mock, + sphinx known_first_party = msgfmt, deluge order_by_type = true not_skip = __init__.py |