beets/docs
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
..
_static Transparent background logo for docs 2023-10-29 10:30:33 +01:00
_templates/autosummary Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
api Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
dev Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
guides Fix Broken link for Arch Linux package 2025-04-08 15:33:43 +02:00
plugins discogs: add configurable search_limit 2025-05-19 09:42:06 +01:00
reference Add changelog note about musicbrainz 2025-05-17 03:32:00 +01:00
.gitignore Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
changelog.rst Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
code_of_conduct.rst Integrate code of conduct 2023-10-27 21:55:13 +10:00
conf.py Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
contributing.rst add CONTRIBUTING.rst to the docs 2020-07-20 19:56:05 -07:00
faq.rst Link to specific bug report/feature request templates in docs 2025-02-16 23:41:00 +00:00
index.rst Integrate code of conduct 2023-10-27 21:55:13 +10:00
Makefile Streamlined auto api referencing for documentation (#5795) 2025-05-22 11:35:40 +02:00
modd.conf Switch to modd for live docs build 2017-12-21 11:39:08 -05:00
team.rst [docs/team] Add '@bal-e' 2024-07-31 23:24:18 +02:00