Commit Graph

33 Commits

Author SHA1 Message Date
Calum Lind 66718f6d8e [Docs] Remove chardet mock to fix requests version check
* chardet is an easily installed pure python module so doesn't need mocking.
2017-06-05 08:10:13 +01:00
Calum Lind b69ba02652 [Core] Refactor default add torrent flags into a constant 2016-11-30 23:21:45 +00:00
Calum Lind 36cbfa8c61 [Lint] Fix files to pass Flake8 v3.2.0 2016-11-17 12:19:41 +00:00
Calum Lind 3a2ff0c188 [Lint] Convert all python double quotes to single quotes
* A rather disruptive change but for a few reasons such as easier to read,
   easier type, keep consistent and javascript code uses single quotes.
 * There are a few exceptions for the automated process:
    * Any double quotes in comments
    * Triple double quotes for docstrings
    * Strings containing single quotes are left e.g. "they're"

 * To deal with merge conflicts from feature branches it is best to follow
   these steps for each commit:
     * Create a patch: `git format-patch -1 <sha1>`
     * Edit the patch and replace double quotes with single except those in
       comments or strings containing an unescaped apostrophe.
     * Check the patch `git apply --check <patchfile>` and fix any remaining
       issues if it outputs an error.
     * Apply the patch `git am < <patchfile>`
2016-11-03 21:45:45 +00:00
bendikro 1e183a3258 [UI] Add gettext.ngettext to __builtin__.__dict__
Handle plurality with getttext using ngettext. Added to
__builtin__.__dict__ as _n
2016-10-30 12:45:02 +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 df3a3c77eb Fix travis build version issue
* version.py script requires git tags but detached HEAD in travis clone
   requires manually creating the RELEASE-VERSION.
 * Also fix relative path issue building docs.
2015-08-26 00:27:32 +01:00
bendikro bb9702910b Update docs tests 2014-09-25 22:12:00 +01:00
Calum Lind b66f313c2d minor code cleanup 2014-09-25 15:56:05 +01:00
Calum Lind fedca3167d [Docs] More fixes for testing with tox 2014-09-25 15:20:15 +01:00
Calum Lind 6a5982f3ce Small fixes for Travis and isort 2014-09-25 14:25:03 +01:00
bendikro 66f2739be7 Added .travis.yml (for travis-ci) and tox.ini files
Targets:

* Runs the unit-tests for python 2.7
* Tests unit-test coverage
* Try to build docs
* Code style checks:
  * flake8
  * isort

Codes changes:
* Fixed tests for httpdownloader (using tmp dir)
* Implemented a couple of tests for Stats plugin but they fail to run on travis

Issues:
* Can't get py26 to work because of installing libtorrent through apt and
  the option system_site_packages fails for 2.6.
2014-09-25 14:11:51 +01:00
Calum Lind 8dc9a0773c Fixes for building docs 2014-09-25 13:43:43 +01:00
Calum Lind 83262afda1 Flake8 codebase
Fixes error E265 and E714 that have been added to newest version of pep8
2014-09-22 12:46:18 +01:00
Calum Lind 6b7df9ca08 Add version fallback for sphinx build with readthedocs 2014-09-20 20:44:55 +01:00
Calum Lind a4edb0080b Fix for building sphinx docs 2014-09-20 18:43:09 +01:00
Calum Lind 30a0f3c9ed Flake8 pass of entire codebase
* Use the inline '# NOQA' to supress N802 lower-case warnings
2014-09-19 19:10:14 +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 c8f2173a04 Use a hack to get the version instead of relying on pkg_resources. This allows the docs to be built without having to install deluge. 2010-03-24 15:36:28 -07:00
Andrew Resch 256ae0745c Update year 2010-03-24 14:29:17 -07:00
Andrew Resch 567a42b0ec Fix some docstrings 2009-08-13 05:02:39 +00: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 e5021cdbc8 remove the docs/build folder
revert the removal of the __rpcapi file for auto-generating the rpc api docs
2009-07-22 20:50:06 +00:00
Damien Churchill f1c192b996 just autodoc the Core and Daemon classes rather than use the RpcApi class 2009-07-22 20:23:16 +00:00
Damien Churchill 698d37f535 setup automatically generating the core's rpc api 2009-07-20 10:51:33 +00:00
Damien Churchill 3c74a8e4bf update the docs, creating a simple structure for user orientated documentation 2009-07-20 09:36:16 +00:00
Damien Churchill c62258fa48 move docs out of the deluge package 2009-07-20 09:02:09 +00:00