summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAge
* [Lint] Fix spelling mistakesCalum Lind2021-09-21
| | | | | | | A quick fix of some of the mistakes caught by codespell. Updated readme with new IRC server Useful to add it as part of linting checks.
* [Install] Update and fix python optional requirementsCalum Lind2021-07-31
| | | | | | | | | | | | | | | * Added required dependency setuptools to install_requires * Remove optional dependency ipaddress from install_requires * Created extras_require in setup.py. The optional dependencies should not be included in install_requires so that users can either install forked dependencies or remove problematic ones. Updated documentation to detail how to install these optional dependencies. * Fixed README badge Refs: * https://dev.deluge-torrent.org/ticket/3470 * https://dev.deluge-torrent.org/ticket/3282 * https://dev.deluge-torrent.org/ticket/3353
* [Tests] Fix tox, pytest and travis issuesCalum Lind2020-04-12
| | | | | | | | | | * Error occurring with Pytest 5.4 so pin to below that version. * Fix minor issues with Travis config. * Use full command-switches for pytest in tox config. * Remove pin for pip as issue with pip-wheel-metadata was fixed in 19.3 * Remove tox-venv as causing issues of incompatible packages installed. The latest versions of the virtualenv package should handle these duties.
* [Docs] Fix changlog symlink and markdown issueCalum Lind2019-11-12
|
* [Docs] Update dev environment instructionst0obz2019-11-12
| | | | | | I'm going through these instructions on a clean Ubuntu 19.04 VM These are the changes I needed to make to get Deluge to build/run
* [Docs] Typo corrections in testing.mdChristopher Beard2019-10-31
|
* [WebUI] Handle torrent add failuresDjLegolas2019-06-21
| | | | Closes #2253.
* [Docs] Fixes for spellingCalum Lind2019-06-18
| | | | Running on Ubuntu Xenial results in spelling warnings so update wordlist.
* [Docs] Add service how-tosCalum Lind2019-06-18
|
* [Docs] Add spellchecking with pyenchantCalum Lind2019-06-15
| | | | | | | | | - Use sphinxcontrib.spelling with custom wordlist. - Skip the checking of the modules documents as they raise false-positives. - Add a setup.py spellcheck_docs command. - Fix spelling and other issues. - Add a doc favicon.
* [Docs] Cleanup updating plugin pageCalum Lind2019-06-15
|
* [Docs] Fix typo and url for Windows installCalum Lind2019-06-12
|
* [Docs] Add more info to release notesCalum Lind2019-06-11
|
* [Docs] Updates to release checklistCalum Lind2019-06-11
|
* [Docs] Remove incomplete Windows install instructionsCalum Lind2019-06-11
| | | | | The instructions are in-progress and missing steps so instead point to the issue ticket for now.
* Fix typo in install instructions for macOSTrav Easton2019-06-11
|
* [Packaging] Add updated launchd scriptsCalum Lind2019-06-08
| | | | | | | | | Copy from Trac UserGuide and updated with proper naming and deluge-web version. The bin location is default for brew with pip install. Closes: #3073
* [Core] Fix SimpleNamespace on Python2Calum Lind2019-06-08
|
* [Docs] Add release notes and update pagesCalum Lind2019-06-08
|
* [Docs] Update release checklistCalum Lind2019-06-07
|
* [Docs] Cleanup changelog and docsCalum Lind2019-06-06
|
* Simplify the get_version methodCalum Lind2019-06-06
| | | | | | | Use post segment instead of dev for non-dev tags. Default to 'deluge-' and '.dev0' to simplify getting version. Refactor to use subprocess.check_output Use deluge.common.get_version as fallback in docs conf.
* [Docs] Update install details and add more pagesCalum Lind2019-05-23
|
* [Docs] Updates and fixes to build on Python 3Calum Lind2019-05-21
| | | | | | | | | | | - Updates to the sphinx conf - Applied Mock fixes to build on Python 3. - Group patches at bottom of conf file. - Use just a major.minor for version. - Specify Sphinx 2.0 version requirement. - Move requirements.txt to docs dir. - Add readthedocs config - Fix docstring code block rst formatting issue.
* [Docs] Fix recommonmark monkey patch and pin versionCalum Lind2019-03-29
| | | | | | The refactored patch did not work so revert it. A new release of recommonmark breaks the docs build so pin it to working version.
* [Docs] Fix formatting of exported docstringsCalum Lind2018-11-16
|
* [Dependency] Remove bundled rencodeCalum Lind2018-11-02
|
* [Plugins] Update create script and add GTK3 how-to docCalum Lind2018-11-02
| | | | | | - Updated create_plugin script to create a GTK3 plugin. - Added a document for updating a 1.3 plugin to be compatible with 2.0.
* [Docs] Fix duplicate description warningsCalum Lind2018-11-02
|
* Cleanup tox configurationCalum Lind2018-11-02
| | | | | | | | | | | | | | | | | | | There were issues with dependencies and tox environments under Python 3 so refactored the tox configuration to be more consistent and clearer. - Moved travis to default to Python 3 for linting and tests. - Fixed missing mock for cairo in sphinx config. - Collated the base deps sections to improve readability. - Added PYTEST_ADDOPTS env to override pytest verbosity in just tox tests as this was a common option being used. - Renamed env 'testcoverage' to the more concise 'coverage' and moved html creation under single env as handy to have this output as well as report. - Cleaned up the isort config for gtk3. - Added `bad-continuation` to pylint config as conflcts with black formatting. - Fix isort issue with bbfreeze script. This will likely be removed in future so just skip sorting it.
* [Docs] Fix mocking external modulesCalum Lind2018-11-02
| | | | | | | | | | | | | With move to GTK3 needed to update the mocking of external modules. There is a new autodoc option `autodoc_mock_imports` so use this instead of the custom mock class. There are some build warnings output using autodoc mock: TypeError: unsupported operand type(s) for |: '_MockObject' and '_MockObject' Will resolve these later as the build passes.
* [GTK3] Change module structure from ui/gtkui to ui/gtk3Calum Lind2018-11-02
| | | | | This moves the directory structure so that there is no conflict with the old gtk2 UI. Also changes the conf and state files being loaded.
* [Docs] Move apidoc command to Sphinx configCalum Lind2018-11-02
| | | | | | | | | The apidoc modules were not being generated on ReadTheDocs because there is no way to run sphinx-apidoc manually. Moved the running of sphinx-apidoc into conf.py. Added zope.interface minimum version to fix Readthedocs warning.
* [Docs] Fix build errors getting Deluge versionCalum Lind2018-11-01
| | | | | | | | | | The use of pkg_resource.require caused an unwanted requirements lookup that errored out the sphinx build when no dependencies are installed. This is fixed by switching to pkg_resources.get_distribution. Also changed the tox docs env to not install Deluge as the setup.py now contains install_requires which is unwanted.
* [Docs] Reorganise and add sections from wikiCalum Lind2018-11-01
| | | | | | | | | | | | | | | | | | | - 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.
* Update pre-commit configCalum Lind2018-10-08
| | | | | | The prettier hook was missing a trailing slash so omitting css files. Add a trailing space fix hook and fix issues.
* Remove Pipfile and pipenvCalum Lind2018-10-08
| | | | | | For now using requirements files and tox to setup a dev env so to prevent confusion or stagnation of Pipfile remove it and pipenv documentation.
* [Lint] Exclude js and css from EOF fixerCalum Lind2018-10-05
| | | | | | | | | | - When running pre-commit on all files it is picking up minified js and css files. Since prettier will format correctly the source files ignore them in end-of-file fixer. - The template files in web docs can be ignored too. - Removed the unneeded `pre-commit-hooks` dependency as pre-commit resolves that itself. - Include files fixed by pre-commit.
* [Docs] Add markdown supportCalum Lind2018-10-04
| | | | | | | | | - Use recommonmark to enable use of markdown files in docs. - Fix theme not specified - Remove unused spelling module. - Cleanup mocking modules in conf so building docs requires only Sphinx. - Simplify tox section, including use of requirements-docs file. Added slimit dependency for sdist-ing deluge package.
* [Lint] Format files with PrettierCalum Lind2018-10-03
| | | | | Use Prettier to auto-format javascript, CSS and YAML files so that less manual work is involved and style is consistent across project.
* [Lint] Use Black to auto-format codeCalum Lind2018-10-03
| | | | | | | | | | | | | | | | | The move to using auto-formatter makes it easier to read, submit and speeds up development time. https://github.com/ambv/black/ Although I would prefer 79 chars, the default line length of 88 chars used by black suffices. The flake8 line length remains at 120 chars since black does not touch comments or docstrings and this will require another round of fixes. The only black setting that is not standard is the use of double-quotes for strings so disabled any formatting of these. Note however that flake8 will still flag usage of double-quotes. I may change my mind on double vs single quotes but for now leave them. A new pyproject.toml file has been created for black configuration.
* Fix the docs run failing on TravisCalum Lind2018-07-28
| | | | | | | | | | Likely that the deprecation warning from cryptography is causing the setup.py sphinx build command to return an error so the tox/travis job is marked as failing. Changing to calling the sphinx-build command directly solves this. Also updated the sphinx config for built-in napoleon and faster builds using jobs option.
* Fixed a minor grammatical error in the deluge console command documentationsam-xif2018-06-18
|
* Skip Failing Tests On WindowsUnknown2018-06-02
|
* Fix files to pass new Flake8 checkersCalum Lind2018-06-01
| | | | | | | | | | | Some new flake8 checkers were added so fix these new warnings and any issues uncovered. Use add-trailing-comma to fix missing trailing commas. It does not format it as well as I would like however it was fast to change and helps with git changes in future. Removed pylint from tox due to large number of warnings.
* Add Pipenv Pipfile for developmentCalum Lind2018-06-01
| | | | | | | | Switching to Pipenv will speed up developement. See the docs for details on using Pipenv. - Added more flake8 checks. - Added `detox` for running tests in parallel locally.
* [Docs] Remove chardet mock to fix requests version checkCalum Lind2017-06-05
| | | | * chardet is an easily installed pure python module so doesn't need mocking.
* Fix type in manpageCalum Lind2017-03-14
|
* Update man pages to reflect ui arg changesCalum Lind2017-03-14
| | | | - Also fixup help output details
* [Core] Refactor default add torrent flags into a constantCalum Lind2016-11-30
|
generated by cgit (git 2.34.1) at 2024-04-27 09:21:22 +0000