beets/docs/api/database.rst
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

47 lines
No EOL
479 B
ReStructuredText

Database
--------
.. currentmodule:: beets.library
Library
'''''''
.. autosummary::
:toctree: generated/
Library
Models
''''''
.. autosummary::
:toctree: generated/
LibModel
Album
Item
Transactions
''''''''''''
.. currentmodule:: beets.dbcore.db
.. autosummary::
:toctree: generated/
Transaction
Queries
'''''''
.. currentmodule:: beets.dbcore.query
.. autosummary::
:toctree: generated/
Query
FieldQuery
AndQuery