Commit graph

78 commits

Author SHA1 Message Date
Dorian
c64fc68b16 more detailed documentation 2021-05-11 22:17:38 +02:00
Dorian Soergel
c9c2c81df6
Merge branch 'master' into beets_tag_hook 2021-05-11 10:46:15 +02:00
Dorian
64238ca8c6 complete documentation 2021-05-11 10:44:33 +02:00
Ryan Lanny Jenkins
79616b42ed Use simpler approach of asserting that at most one handler of import_task_before_choice returns an action. 2021-03-28 16:53:01 -05:00
Ryan Lanny Jenkins
39b5a7636c Add line in dev docs for new hook. 2021-03-27 12:04:25 -05:00
Dorian
00b08d52d5 style following review 2021-02-06 15:07:10 +01:00
soergeld
79e5b89caf documentation and changelog 2021-01-09 16:54:14 +01:00
Adrian Sampson
9657919968
Merge pull request #3088 from rubdos/reflink
Add reflink option
2020-11-27 13:29:10 -05:00
jtpavlock
c9f59ee38d
Add broken link checker to integration test (#3703)
* fix broken links
* add link check command to tox
* add link check to the weekly integration test
2020-09-04 15:42:36 -05:00
Ruben De Smet
e1def7559e Add reflink docs 2020-07-22 18:01:39 +02:00
FichteFoll
728203e15a
beets.io now supports HTTPS
See https://github.com/beetbox/beets/pull/3297.
2019-06-06 15:34:15 +02:00
Carl Suster
6769da29ae docs: add dev importer and cli text from wiki 2019-06-05 13:28:06 +10:00
Carl Suster
de78151eea docs: rename api -> library 2019-06-05 13:18:46 +10:00
Carl Suster
918024a465 docs: document mtime management 2019-06-05 13:16:12 +10:00
Carl Suster
e27c6e480b docs: add query API reference 2019-06-05 13:10:10 +10:00
Carl Suster
984aa223c6 docs: highlight model field API 2019-06-05 13:03:36 +10:00
Carl Suster
0e65800fbc Expand library API docs 2019-06-05 12:49:39 +10:00
FichteFoll
aa31fea037
Update a lot of URLs to use HTTPS
*All* URLs were checked manually, but only once per domain!

I mostly concerned myself with URLs in documentation rather than source
code because the latter may or may not have impactful changes, while the
former should be straight forward.

Changes in addition to simply adding an s:

- changed pip and pypi references as their location has changed
- MPoD (iOS app) url redirects to Regelian, so I replaced those
- updated homebrew references

Notable observations:

- beets.io does have HTTPS set up properly (via gh-pages)
- beatport.py uses the old HTTP url for beatport
- as does lyrics.py for lyrics.wikia.com
- https://tomahawk-player.org/ expired long ago, but the http page
  redirects to https regardless
- none of the sourceforge subdomains have https (in 2019!)
2019-06-05 03:11:49 +02:00
Carl Suster
a82002e6c1 confit: replace with confuse in core beets 2019-06-01 09:51:56 +10:00
Carl Suster
1289efeeee mediafile: update docs for MediaFile split 2019-05-29 09:35:14 +10:00
Carl Suster
d5507dc956 docs: remove reference to BeetsPlugin.listen
This decorator was removed in 4578c4f0e1 and now
`BeetsPlugin.register_listener` should be used instead. Fixes #2885.
2019-04-20 18:13:28 +10:00
Adrian Sampson
22c8289269 Support plugin-provided named queries 2019-02-17 13:49:54 -05:00
Adrian Sampson
323d90db17 Tiny ReST markup tweaks (#2814) 2018-02-22 15:51:15 -05:00
Michal Koutenský
305f9f2dfb Document 'early_import_stages' in the docs 2018-02-21 16:01:26 +01:00
Jacob Gillespie
b4efecb709 Add option to hardlink when importing 2017-02-19 15:56:13 -06:00
Adrian Sampson
8937eec50a Refactor built-in stnadard choices 2016-12-28 14:15:40 -05:00
Adrian Sampson
2f6538aee2 Refactor search options to ordinary choices
`PromptChoice`s can now return `Proposal` values, which makes these two
options just "normal" actions that could be provided by plugins.
2016-12-28 14:08:09 -05:00
Diego Moreda
b7a2a42d9c Fix docs on plugin prompt choices conflict solving
* Fix docstring and `plugins.rst` regarding how the PromptChoices that
use the same short letter are handled (they are discarded instead of
raising an Exception).
2016-01-28 13:01:44 +01:00
Adrian Sampson
5369a60a2a More details on log levels (fix #1781) 2015-12-30 21:21:30 -08:00
Diego Moreda
6f8a1aa40a Prompt event documentation and mbsubmit fixes
* Fixes for documentation of the prompt event (missing reserved letter, typos).
* Update sample mbsubmit plugin to conform to the new PromptChoice structure.
2015-12-16 19:26:39 +01:00
Diego Moreda
c94679e143 Add prompt event documentation
* Add documentation for the before_choose_candidate event (add event to the
event list and add section with example usage).
2015-12-15 20:13:34 +01:00
Adrian Sampson
cb6edb46ef Use ` instead of * for plugin event names 2015-11-07 12:12:48 -08:00
Adrian Sampson
4e20ddcef9 Doc refinements for #1499 2015-11-07 12:11:05 -08:00
Manfred Urban
17b38a6be8 Minor layout fixes to documentation 2015-11-05 16:43:28 +01:00
Manfred Urban
5e4c41ffe8 Clarified documentation 2015-11-05 16:37:35 +01:00
Manfred Urban
ae0babb17e Less duplicated text in documentation 2015-11-05 16:17:19 +01:00
Manfred Urban
1708939f99 - Added hooks to manipulate fetched album and track info
- Integrated support for plugins
- Added documentation
- Updated changelog
2015-11-05 15:17:58 +01:00
Adrian Sampson
079822b893 Importer: no separate stage for applying metadata
It's cheaper and easier to just apply metadata in the UI thread. The
advantage, then, is that we no longer need to keep track of anything in-memory
to enumerate data that has been seen by the user but not added to the database
yet!

In the next step, I'll remove `seen_idents` altogether.
2015-10-24 13:03:26 -07:00
multikatt
b8fdd163b9 Fix capitalization of examples and add a comma
Fixes syntax highlighting
2015-07-05 14:29:37 -04:00
David
c3745ce6c2 typo: exapnds -> expands 2015-04-09 12:30:38 -04:00
David
09100c4a55 Update plugins.rst
The class is called CommonOptionsParser, Option*s*.
2015-04-05 22:44:08 -04:00
Bruno Cauet
c6f6e3164a Merge branch 'thread-safe-logging2' 2015-04-01 10:45:12 +02:00
Adrian Sampson
b477f4a53f Merge pull request #1376 from tomjaspers/config-redacted-fields
Config: new option -r redacts sensitive fields

Conflicts:
	beets/util/confit.py
2015-03-27 22:11:24 -04:00
Tom Jaspers
ce78be3eb6 Config: add docs & tests for --redacted option 2015-03-26 12:49:54 +01:00
Adrian Sampson
127b92598c Clarify plugin verbosity docs (taken from sampsyo/thread-safe-logging) 2015-03-25 12:55:39 +01:00
Bruno Cauet
191ff61c53 Document the database_change parameter update 2015-03-16 18:44:52 +01:00
Bruno Cauet
58b39f1000 Merge branch 'master' into subcommand-auto-format-path 2015-03-05 17:53:31 +01:00
Bruno Cauet
6fda0e23fc Update docs & changelog 2015-03-05 17:40:32 +01:00
Taeyeon Mori
ddf86af3a0 DOCS The plugin stages now receive the ImportSession as first argument 2015-03-01 19:52:11 +01:00
Bruno Cauet
a014750e2d Update docs: mention multi-level logging
If you think what I wrote suck, it's because it does.
2015-02-10 17:29:02 +01:00