mirror of
https://github.com/beetbox/beets.git
synced 2025-12-12 11:36:27 +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
28 lines
736 B
ReStructuredText
28 lines
736 B
ReStructuredText
{{ fullname | escape | underline}}
|
|
|
|
.. currentmodule:: {{ module }}
|
|
|
|
.. autoclass:: {{ objname }}
|
|
:members: <-- add at least this line
|
|
:private-members:
|
|
:show-inheritance: <-- plus I want to show inheritance...
|
|
:inherited-members: <-- ...and inherited members too
|
|
|
|
{% block methods %}
|
|
.. automethod:: __init__
|
|
|
|
{% if methods %}
|
|
.. rubric:: {{ _('Public methods summary') }}
|
|
|
|
.. autosummary::
|
|
{% for item in methods %}
|
|
~{{ name }}.{{ item }}
|
|
{%- endfor %}
|
|
{% for item in _methods %}
|
|
~{{ name }}.{{ item }}
|
|
{%- endfor %}
|
|
{% endif %}
|
|
{% endblock %}
|
|
|
|
.. rubric:: {{ _('Methods definition') }}
|
|
|