Šarūnas Nejus
9519d47d57
Convert Python 2 URLs to Python 3
2025-10-19 01:37:42 +01:00
Šarūnas Nejus
7fa9a30b89
Add note regarding the last plugin class
2025-10-14 16:17:29 +01:00
Šarūnas Nejus
4cb667cbb3
Fix formatting issues
2025-09-04 12:49:48 +01:00
Šarūnas Nejus
f8a98ac518
Add index for API Reference
2025-09-04 12:49:48 +01:00
Šarūnas Nejus
33feb0348d
Define replacements for commonly used classes
2025-09-04 12:49:47 +01:00
Sebastian Mohr
09da8a2991
- Updated git blame ignore with new hashes
...
- run docstrfmt
2025-09-04 12:49:47 +01:00
J0J0 Todos
33f1a5d0be
docs: Split Further Reading chapter to files
...
to make it viewable in the primary sidebar instead of the secondary.
2025-09-04 12:49:46 +01:00
Sebastian Mohr
1c6921758c
Capitalization and some more minor adjustments. Updated docstrfmt.
2025-09-04 12:49:46 +01:00
Sebastian Mohr
db9a587492
Replaced named citations with number, seems to work for some reason.
2025-09-04 12:49:45 +01:00
Sebastian Mohr
4a8cabdaeb
Use rubric instead of list table.
2025-09-04 12:49:45 +01:00
Sebastian Mohr
dee906e1ae
Minor formatting issues.
2025-09-04 12:49:45 +01:00
Sebastian Mohr
037e59fe8f
Created autotagger file and enhanced the docs significantly.
2025-09-04 12:49:45 +01:00
Sebastian Mohr
676dc9c953
Replaced writing-plugins with basic-plugin-setup.
2025-09-04 12:49:44 +01:00
Sebastian Mohr
0dcd7caa9d
writing plugins label
2025-09-04 12:49:44 +01:00
Sebastian Mohr
d6e3548d4a
Formatting commands
2025-09-04 12:49:43 +01:00
Sebastian Mohr
1dfd232270
further reading formatting and changed extending the autotagger to
...
conform to new metadatasource plugin.
2025-09-04 12:49:43 +01:00
Sebastian Mohr
6627a0740c
Changed events doc list to table. Added references to api.
2025-09-04 12:49:43 +01:00
Sebastian Mohr
35ea9a7011
Enhanced index, changed wording slightly
2025-09-04 12:49:43 +01:00
Sebastian Mohr
69b47b3071
A number of smaller additions.
2025-09-04 12:49:43 +01:00
Sebastian Mohr
07549ed896
Moved plugin docs into folder.
2025-09-04 12:49:42 +01:00
Šarūnas Nejus
9352a79e41
Replace percent formatting
2025-08-30 22:35:00 +01:00
Š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
Damon McDougall
268075063f
Use python3 print in plugins.rst
2025-07-29 10:06:30 +02:00
Sebastian Mohr
9584216209
Streamlined auto api referencing for documentation ( #5795 )
...
## Description
The current developer documentation feels somewhat cluttered due to
inline auto-generated API references for certain classes. To improve
readability and maintainability, this PR introduces a more streamlined
approach that aligns better with best practices observed in other PyData
ecosystem documentation.
Specifically, this PR:
- Adds a dedicated `api/` folder to the documentation structure.
- Moves all auto-generated references (classes, methods, etc.) to this
folder.
- Enables clean, concise linking to API elements from the narrative
documentation—without interrupting human-written content with large
autogenerated blocks.
This separation makes the documentation easier to navigate and maintain,
while still providing full API reference coverage where needed.
- [x] Documentation
- [x] Changelog
2025-05-22 11:35:40 +02:00
Sebastian Mohr
68acaa6470
Renamed all action occurrences with Action.
2025-05-13 13:01:46 +02:00
Sebastian Mohr
7e61027366
Added suggestions from code review
2025-04-15 11:49:24 +02:00
Sebastian Mohr
753bdd9106
Added typehints for _instance, _classes and for class attributes.
2025-04-08 18:15:08 +02:00
Šarūnas Nejus
89f1ef4d2f
Add documentation links
2025-01-30 12:20:11 +00:00
Šarūnas Nejus
916d40f86f
Remove outdated namespace package definition and update docs
...
See https://realpython.com/python-namespace-package .
This setup is backwards-compatible, so plugins using the old
pkgutil-based setup will continue working fine.
This setup has an advantage where external plugins will now be able to
import modules from 'beetsplug' package for typing purposes. Previously,
mypy could not resolve these modules due to presence of `__init__.py`.
2025-01-30 12:20:11 +00:00
valrus
1af9df2b40
add another benefit of item_types
2024-12-29 08:04:50 -08:00
Šarūnas Nejus
0aa361e6c8
Remove support for Python 3.7 in the build and docs
2024-06-05 04:41:02 +01:00
Callum Brown
1cde938769
Document Album.items() / LibModel.items() conflict
...
Closes: https://github.com/beetbox/beets/issues/4404
2022-07-12 11:21:52 +01:00
Callum Brown
fcb73ad095
Clarify docs for writing plugins
...
If the beetsplug directory itself is added to the python path
then python does not see the plugin as part of the beetsplug namespace.
2021-12-19 15:41:31 +00:00
David Logie
73c7cc86fe
Add an 'album_removed' event.
...
This works similarly to the existing 'item_removed' event but is called
with an `Album` object.
2021-11-22 20:56:50 +00:00
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
