summaryrefslogtreecommitdiffstats
path: root/tox.ini
diff options
context:
space:
mode:
authorCalum Lind <calumlind@gmail.com>2018-10-05 09:33:26 +0100
committerCalum Lind <calumlind@gmail.com>2018-11-01 17:38:10 +0000
commit82ecf8a4168cafdc2bf0f5c37f7fa45d55e8d265 (patch)
treeefd52f493583a3c99853d6577660da0695e95fc8 /tox.ini
parent9dcd90056d4225f65046fab4ed37a25e9caeda06 (diff)
downloaddeluge-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 'tox.ini')
-rw-r--r--tox.ini6
1 files changed, 4 insertions, 2 deletions
diff --git a/tox.ini b/tox.ini
index 564b33679..bb6b096a5 100644
--- a/tox.ini
+++ b/tox.ini
@@ -154,14 +154,16 @@ deps =
-rrequirements-docs.txt
[testenv:docs]
+basepython = python2.7
sitepackages = {[docsbase]sitepackages}
deps = {[docsbase]deps}
commands =
python setup.py clean_docs
- sphinx-apidoc --force -o docs/source/modules/ deluge deluge/plugins
+ sphinx-apidoc --force --no-toc -o docs/source/modules/ deluge deluge/plugins
sphinx-build -v -j auto -E -T -b html -d docs/build/doctrees docs/source docs/build/html
[testenv:docscoverage]
+basepython = python2.7
sitepackages = {[docsbase]sitepackages}
changedir = {[docsbase]changedir}
deps =
@@ -175,7 +177,7 @@ commands =
# ========================
-# Developement Environment
+# Development Environment
# ========================
[basedev]
usedevelop = True