mirror of
https://github.com/beetbox/beets.git
synced 2025-12-07 17:16:07 +01:00
9584216209
## 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
27 lines
520 B
ReStructuredText
27 lines
520 B
ReStructuredText
For Developers
|
|
==============
|
|
|
|
This section contains information for developers. Read on if you're interested
|
|
in hacking beets itself or creating plugins for it.
|
|
|
|
See also the documentation for `MediaFile`_, the library used by beets to read
|
|
and write metadata tags in media files.
|
|
|
|
.. _MediaFile: https://mediafile.readthedocs.io/en/latest/
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
plugins
|
|
library
|
|
importer
|
|
cli
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: API Reference
|
|
|
|
../api/plugins
|
|
../api/database
|
|
|