Šarūnas Nejus
ab5acaabb3
Reformat all docs using docstrfmt
2025-08-10 16:25:05 +01:00
Šarūnas Nejus
769dcdc88a
Docs: fix linting issues
2025-08-10 16:16:02 +01:00
Šarūnas Nejus
7bbd215efc
Update all docs with Poetry
2024-06-10 13:10:16 +01:00
Graham R. Cobb
680ccdcd96
Documentation and changelog for web `readonly` option fixing #3870 .
...
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-11 23:09:51 +00:00
Graham R. Cobb
49c747d144
Small documentation change to make GET /album/.../art clearer
...
Signed-off-by: Graham R. Cobb <g+beets@cobb.uk.net>
2021-03-06 15:14:41 +00:00
Cadel Watson
3723f8a09f
Update docs and changelog
2020-09-20 10:54:06 +10: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
Adrian Sampson
969a207418
Simplify docs for #3567
2020-04-27 07:45:31 -04:00
Sören Tempel
226d8089e1
docs: document special handling of backlash in web plugin queries
2020-04-27 13:36:36 +02:00
Sören Tempel
57a759c817
docs: document joining of paths performed by web plugin for queries
2020-04-27 13:36:36 +02:00
FichteFoll
c144141e9a
Update a few more http URLs to https that I missed
...
Should really be all now (pending the next commit).
2019-06-05 23:07:11 +02: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
Adrian Sampson
6d5a1e9284
web docs: Split CORS credentials paragraph ( #2821 )
2018-02-26 18:02:16 -05:00
Samuel Loury
e3599742b4
Add a support for supports_credentials
...
If the web plugin is behind a credential based http server and is
accessed by another in-browser client in another domain, the
specification of CORS requires the server to indicate it supports
such credentials.
2018-02-26 21:08:02 +01:00
Adrian Sampson
9b383f87f4
Docs: consistent description of a Boolean option
2017-03-19 21:27:00 -04:00
Adrian Sampson
095f596e5c
Clarity in the reverse_proxy docs
2017-03-19 21:25:18 -04:00
Adrian Sampson
be85825b60
Typo and formatting fixes in docs
2017-03-19 21:20:14 -04:00
Olivier Biesmans
68fa666644
Document the `reverse_proxy' option
2017-03-19 20:45:26 +00:00
Steve Johnson
1426aea4a2
Update docs
2017-01-15 11:21:59 -08:00
Steve Johnson
866a650bc0
Rename /item/by_path to /item/path and use PathQuery instead of direct file access
2017-01-15 11:21:33 -08:00
Steve Johnson
05bc4996a8
Rename and invert new config option
2017-01-15 11:21:33 -08:00
Steve Johnson
a994df6aa6
Fix bad doc formatting
2017-01-15 11:21:33 -08:00
Steve Johnson
c409a71ea1
Add missing plus signs to web.rst
2017-01-15 11:21:33 -08:00
Steve Johnson
43936cd84c
/item/at_path/ endpoint
...
More at_path
/item/by_path docs
2017-01-15 11:21:33 -08:00
Steve Johnson
29d61ca634
web.exclude_paths_from_items option
...
More exclude_paths_from_items
2017-01-15 11:21:33 -08:00
Adrian Sampson
957bfacf21
Fix Backbone.js link
2016-11-30 08:40:15 -05:00
Max Ammann
4be45eacc6
Added documentation for the new 'expand' flag
2016-06-26 19:53:57 +02:00
Adrian Sampson
77f51133aa
Fiddle with CORS dependency docs ( #1237 )
2015-01-21 09:17:53 -08:00
Adrian Sampson
a82f6c2d76
Docs tweaks and changelog for #1237 , fix #1236
2015-01-20 14:10:33 -08:00
Andre Miller
5cf869e0f8
Updated web documentation for CORS
2015-01-20 20:52:24 +02:00
Fabrice Laporte
f7ecb9cbae
doc: emphasize options names by using bold font instead of fixed width
2014-11-07 22:13:25 +01:00
Adrian Sampson
930581ac99
Finish the pass over all plugin docs
2014-10-30 22:42:11 -07:00
Fabrice Laporte
b922abef06
docs: remove space before colon
2014-10-28 23:23:44 +01:00
Fabrice Laporte
2cd76b6714
docs: add plugin name in "how to configure" sentences
2014-10-28 23:23:10 +01:00
Fabrice Laporte
cb350de2ea
harmonize all plugins docs
...
Add a configuration section that lists all options for each plugin.
List options in alphabetic order.
Mention the default value for each option.
Use same sentences to describe concepts common to different plugins eg 'auto
option, install description
2014-10-26 22:29:10 +01:00
Adrian Sampson
033cf9ec21
spell check
2014-04-15 21:17:23 -07:00
camikazegreen
8144ccf74b
Minor typo fix
2014-04-15 13:19:23 -07:00
Adrian Sampson
036051ed88
silence a ReST complaint
2014-02-02 13:15:50 -08:00
Thomas Scholtes
f4ad66063c
Fix typos in web doc
2014-02-02 19:20:41 +01:00
Thomas Scholtes
b392ff1c94
JSON API documentation
2014-02-02 19:04:04 +01:00
Adrian Sampson
11e1fd1bd8
document new Confit-based configuration
2012-12-20 21:56:47 -08:00
Wieland Hoffmann
70910f5ac1
Fix the reference to the ".beetsconfig" doc in plugins/web
2012-07-12 11:19:49 +02:00
Adrian Sampson
521131bc2b
screenshot image and syntax cleanup
2011-09-17 15:32:27 -07:00
Adrian Sampson
2073b2e5f4
web plugin page
2011-09-17 13:39:06 -07:00
