Commit graph

8 commits

Author SHA1 Message Date
Šarūnas Nejus
33feb0348d
Define replacements for commonly used classes 2025-09-04 12:49:47 +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
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
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
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
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
de78151eea docs: rename api -> library 2019-06-05 13:18:46 +10:00
Renamed from docs/dev/api.rst (Browse further)