Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-06 16:42:42 +01:00
Code Issues Projects Releases Wiki Activity
12937 commits 43 branches 64 tags 59 MiB
Commit graph

100 commits

Author SHA1 Message Date
JOJ0
e837598e79 Increment version to 2.4.0 2025-09-13 16:47:21 +00:00
Šarūnas Nejus
f8a98ac518
Add index for API Reference 2025-09-04 12:49:48 +01:00
Šarūnas Nejus
33feb0348d
Define replacements for commonly used classes 2025-09-04 12:49:47 +01:00
J0J0 Todos
fddda507ea
docs: Reveal 3 nav levels in primary sidebar 
and also allow a max level of 3 to expand.
 2025-09-04 12:49:46 +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
snejus
d487d675b9 Increment version to 2.3.1 2025-05-14 09:53:19 +00:00
snejus
250b0da900 Increment version to 2.3.0 2025-05-07 22:34:25 +00:00
Šarūnas Nejus
a1e85727f5
Enable colors in the docs 2025-01-19 00:30:47 +00:00
Šarūnas Nejus
64b3481235
Take into account Sphinx updates in docs and release script 2025-01-12 04:50:45 +00:00
snejus
f92c0ec8b1 Increment version to 2.2.0 2024-12-02 06:56:49 +00:00
snejus
bc16ed1817 Increment version to 2.1.0 2024-11-22 01:50:28 +00:00
Šarūnas Nejus
c2a13ee4b1
Format docs/conf.py 2024-06-11 15:22:58 +01:00
Serene-Arc
33ab22db8c Increment version numbers to 2.0.0 2024-05-30 04:05:25 +00:00
J0J0 Todos
d80d45974b Transparent background logo for docs 
Exchange the white-bg logo with a transparent-bg version, to ensure
Sphinx pydata theme also looks well when switched to dark
mode.
 2023-10-29 10:30:33 +01:00
J0J0 Todos
af6258301c Add beets.css customizing Sphinx theme "pydata" 
- Set static path and css file in Sphinx config.
- Codebox style to black/white
- Secondary color to beetroot red
- Inline code color to beetroot green
- Leave primary color (pydata teal), difficult to read with beetroot
  green. Works well with beetroot red actually.
- Leave some notes on colors in beets.css for reference.
 2023-10-23 12:09:55 +02:00
J0J0 Todos
c1e2b34aa2 Rename assets/ to _static/ (logo, css, custom Sphinx stuff) 2023-10-23 10:12:19 +02:00
J0J0 Todos
4dc1f251d7 Revert "Set and configure Sphinx theme book" 
This reverts commit 71873b66de.

Revert back to using "pydata" theme. Keep this in the history, just in
case we reconsider to using "book".
 2023-10-23 09:53:56 +02:00
J0J0 Todos
71873b66de Set and configure Sphinx theme book 
- Reduce base font a bit by custom.css
- Collapse nav
- Title "beets" below logo
 2023-10-23 09:51:52 +02:00
J0J0 Todos
957a6e445c Set and configure Sphinx theme "pydata" 
- Collapse nav
- Add title "beets" next to small logo on top left
 2023-10-23 09:51:52 +02:00
J0J0 Todos
ff7d5f7c3a Set and configure Sphinx theme "readthedocs" 
- Sticky Nnavigation (default but make sure)
- Top left area white, to fit with beets logo background
- Title "beets"
- Logo only false, we want to see title
- Version true, we want to see which beets version we are looking at
- Issue: The latter two are invisible, would require custom CSS!!!
 2023-10-23 09:51:52 +02:00
J0J0 Todos
9e972fe8ae Set and configure Sphinx theme "alabaster" 
- Fixed sidebar
- Sidebar collapse (default but make sure)
 2023-10-23 09:51:52 +02:00
J0J0 Todos
a6032cdaa9 Add beets logo to docs 
and leave html_static_path commented out in conf.py as a reminder. We
might need it if builds via readthedocs require it.
 2023-10-23 09:51:36 +02:00
Serene-Arc
a6e5201ff3 Apply formatting tools to all files 
This is 'the big one', which touches every file so that it all conforms
to the given standard.
 2023-10-22 09:53:18 +10:00
J0J0 Todos
e9dd345601 Fixate sidebar in docs Alabaster theme 
This is a quickfix to get back the behaviour we previously had with the
readthedocs theme. There could be adjusted and fixed more, but postpone that
and do in a proper PR.
 2023-09-21 07:23:51 +02:00
Jack Wilsdon
2106f471af Add missing placeholders to extlinks captions 
Sphinx 6.0.0 changed extlinks to always require placeholders in link
captions. See 93cf1a57d9
 2022-12-31 14:23:34 +00:00
Adrian Sampson
e3f4e19298
Version bump: v1.6.1 2021-11-27 11:38:48 -05:00
Adrian Sampson
f33606c87a
Switch version to 1.6.0 
Especially with the Python version changes, it seems like this justifies
more than a 0.0.1 bump.
 2021-11-27 11:17:14 -05:00
wisp3rwind
c8bfad5e17 docs: fix links that were failing sphinx' linkcheck 
There's one stale link left for the gmusic plugin, which should be fixed
by removing the plugin, see #4089
 2021-10-04 16:14:14 +02:00
Andrew Rogl
0f48ccde78 Final pyupgrade 2021-08-26 20:14:08 +10:00
Adrian Sampson
21e11f5bb3
Version bump: v1.5.1 2021-08-19 15:57:14 -04:00
Jack Wilsdon
14a5630381
Add genius to linkcheck ignore list 2020-10-22 00:07:49 +01:00
Jack Wilsdon
7621cdfeb9
Fix GitHub user page regex 2020-10-22 00:06:44 +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
Adrian Sampson
1835422934 Version bump: 1.5.0 2019-05-30 20:08:03 -04:00
Adrian Sampson
a34f19e01c Version bump: 1.4.9 
Given what we have in the pipeline, we may need to change this to 1.5.0
instead...
 2019-05-16 20:44:38 -04:00
Carl Suster
2e0230789f docs: fix some markup issues and typos 2019-04-27 12:43:13 +10:00
Adrian Sampson
8ba2ccdc63 Improve changelog text 
Co-Authored-By: arcresu <carl@contraflo.ws>
 2019-04-24 11:06:19 +10:00
Adrian Sampson
a8080fa750 Version bump: 1.4.8 2018-05-29 16:07:38 -04:00
Adrian Sampson
61a752d234 Version bump: 1.4.7 2017-12-21 13:16:12 -05:00
Adrian Sampson
7e8056b0e8 Version bump: 1.4.6 2017-06-20 14:49:19 -04:00
Adrian Sampson
8842bd3ecc Version bump: 1.4.5 2017-06-10 16:28:50 -04:00
Adrian Sampson
0bd6062ee9 Version bump: 1.4.4 2017-01-09 10:40:06 -05:00
Adrian Sampson
faf2b9feb3 Version bump: 1.4.3 2016-12-16 22:07:34 -05:00
Adrian Sampson
cf5fa501e2 Version bump: 1.4.2 2016-11-25 22:16:03 -05:00
Adrian Sampson
60ec732e10 Version bump: 1.4.1 2016-11-25 21:38:06 -05:00
Adrian Sampson
b49d3344d4 Next release version is 1.4.0, not 1.3.20 
It's time for a minor version bump with our six dependency and "experimental"
Python 3 support.
 2016-07-02 10:11:31 -07:00
Adrian Sampson
035bf96558 Version bump: 1.3.20 2016-06-25 17:53:20 -07:00
Adrian Sampson
2b9f4773a9 Version bump: 1.3.19 2016-05-31 10:43:36 -07:00
wordofglass
0f89f17227 add missing division future imports 2016-04-16 18:33:54 +02:00
wordofglass
0cfddfaa8a add missing absolute_import future imports 2016-04-16 02:28:54 +02:00