github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 08:56:17 +00:00
Code Issues Releases Wiki Activity

API doc: try to unify table, left align

Browse Source
This commit is contained in:
Alban Féron 2021-01-23 15:40:32 +01:00
parent 11887d07d2
commit 4735003bc4
No known key found for this signature in database
GPG Key ID: 8CE0313646D16165
3 changed files with 737 additions and 538 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/_static/custom.css vendored Normal file
View File

@ -0,0 +1,4 @@
table.align-default {
margin-left: 0;
margin-right: 0;
}

195
docs/api.rst
View File

@ -30,6 +30,9 @@ or with version 1.8.0.
All methods / pseudo-TOC All methods / pseudo-TOC
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
.. table::
:widths: 55 30 15
=========================== ====== = =========================== ====== =
Method Vers. Method Vers.
=========================== ====== = =========================== ====== =
@ -116,6 +119,9 @@ Global
Parameters used for any request Parameters used for any request
.. table::
:widths: 55 30 15
===== ====== = ===== ====== =
P. Vers. P. Vers.
===== ====== = ===== ====== =
@ -130,6 +136,9 @@ P. Vers.
Error codes Error codes
.. table::
:widths: 55 30 15
== ====== = == ====== =
# Vers. # Vers.
== ====== = == ====== =
@ -176,6 +185,9 @@ Browsing
``getIndexes`` ``getIndexes``
✔️ ✔️
.. table::
:widths: 55 30 15
=================== ===== = =================== ===== =
Parameter Vers. Parameter Vers.
=================== ===== = =================== ===== =
@ -188,6 +200,9 @@ Browsing
``getMusicDirectory`` ``getMusicDirectory``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -206,6 +221,9 @@ Browsing
``getArtists`` ``getArtists``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -217,6 +235,9 @@ Browsing
``getArtist`` ``getArtist``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -228,6 +249,9 @@ Browsing
``getAlbum`` ``getAlbum``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -239,6 +263,9 @@ Browsing
``getSong`` ``getSong``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -257,6 +284,9 @@ Browsing
``getVideoInfo`` ``getVideoInfo``
🔴 1.15.0 🔴 1.15.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -268,6 +298,9 @@ Browsing
``getArtistInfo`` ``getArtistInfo``
📅 1.11.0 📅 1.11.0
.. table::
:widths: 55 30 15
===================== ====== = ===================== ====== =
Parameter Vers. Parameter Vers.
===================== ====== = ===================== ====== =
@ -281,6 +314,9 @@ Browsing
``getArtistInfo2`` ``getArtistInfo2``
📅 1.11.0 📅 1.11.0
.. table::
:widths: 55 30 15
===================== ====== = ===================== ====== =
Parameter Vers. Parameter Vers.
===================== ====== = ===================== ====== =
@ -294,6 +330,9 @@ Browsing
``getAlbumInfo`` ``getAlbumInfo``
📅 1.14.0 📅 1.14.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -305,6 +344,9 @@ Browsing
``getAlbumInfo2`` ``getAlbumInfo2``
📅 1.14.0 📅 1.14.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -316,6 +358,9 @@ Browsing
``getSimilarSongs`` ``getSimilarSongs``
❔ 1.11.0 ❔ 1.11.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -328,6 +373,9 @@ Browsing
``getSimilarSongs2`` ``getSimilarSongs2``
❔ 1.11.0 ❔ 1.11.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -340,6 +388,9 @@ Browsing
``getTopSongs`` ``getTopSongs``
❔ 1.13.0 ❔ 1.13.0
.. table::
:widths: 55 30 15
========== ====== = ========== ====== =
Parameter Vers. Parameter Vers.
========== ====== = ========== ====== =
@ -355,6 +406,9 @@ Album/song lists
``getAlbumList`` ``getAlbumList``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -375,6 +429,9 @@ Album/song lists
``getAlbumList2`` ``getAlbumList2``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -395,6 +452,9 @@ Album/song lists
``getRandomSongs`` ``getRandomSongs``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ===== = ================= ===== =
Parameter Vers. Parameter Vers.
================= ===== = ================= ===== =
@ -410,6 +470,9 @@ Album/song lists
``getSongsByGenre`` ``getSongsByGenre``
✔️ 1.9.0 ✔️ 1.9.0
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -431,6 +494,9 @@ Album/song lists
``getStarred`` ``getStarred``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -442,6 +508,9 @@ Album/song lists
``getStarred2`` ``getStarred2``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -456,6 +525,9 @@ Searching
``search`` ``search``
✔️ ✔️
.. table::
:widths: 55 30 15
============= ===== = ============= ===== =
Parameter Vers. Parameter Vers.
============= ===== = ============= ===== =
@ -473,6 +545,9 @@ Searching
``search2`` ``search2``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -491,6 +566,9 @@ Searching
``search3`` ``search3``
✔️ ✔️
.. table::
:widths: 55 30 15
================= ====== = ================= ====== =
Parameter Vers. Parameter Vers.
================= ====== = ================= ====== =
@ -512,6 +590,9 @@ Playlists
``getPlaylists`` ``getPlaylists``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -523,6 +604,9 @@ Playlists
``getPlaylist`` ``getPlaylist``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -534,6 +618,9 @@ Playlists
``createPlaylist`` ``createPlaylist``
✔️ ✔️
.. table::
:widths: 55 30 15
============== ===== = ============== ===== =
Parameter Vers. Parameter Vers.
============== ===== = ============== ===== =
@ -547,6 +634,9 @@ Playlists
``updatePlaylist`` ``updatePlaylist``
✔️ ✔️
.. table::
:widths: 55 30 15
===================== ===== = ===================== ===== =
Parameter Vers. Parameter Vers.
===================== ===== = ===================== ===== =
@ -563,6 +653,9 @@ Playlists
``deletePlaylist`` ``deletePlaylist``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -577,6 +670,9 @@ Media retrieval
``stream`` ``stream``
✔️ ✔️
.. table::
:widths: 55 30 15
========================= ====== = ========================= ====== =
Parameter Vers. Parameter Vers.
========================= ====== = ========================= ====== =
@ -594,6 +690,9 @@ Media retrieval
``download`` ``download``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -605,6 +704,9 @@ Media retrieval
``hls`` ``hls``
🔴 1.9.0 🔴 1.9.0
.. table::
:widths: 55 30 15
============== ====== = ============== ====== =
Parameter Vers. Parameter Vers.
============== ====== = ============== ====== =
@ -618,6 +720,9 @@ Media retrieval
``getCaptions`` ``getCaptions``
🔴 1.15.0 🔴 1.15.0
.. table::
:widths: 55 30 15
========== ====== = ========== ====== =
Parameter Vers. Parameter Vers.
========== ====== = ========== ====== =
@ -630,6 +735,9 @@ Media retrieval
``getCoverArt`` ``getCoverArt``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -642,6 +750,9 @@ Media retrieval
``getLyrics`` ``getLyrics``
✔️ ✔️
.. table::
:widths: 55 30 15
========== ===== = ========== ===== =
Parameter Vers. Parameter Vers.
========== ===== = ========== ===== =
@ -654,6 +765,9 @@ Media retrieval
``getAvatar`` ``getAvatar``
❌ ❌
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -668,6 +782,9 @@ Media annotation
``star`` ``star``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -681,6 +798,9 @@ Media annotation
``unstar`` ``unstar``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -694,6 +814,9 @@ Media annotation
``setRating`` ``setRating``
✔️ ✔️
.. table::
:widths: 55 30 15
========== ===== = ========== ===== =
Parameter Vers. Parameter Vers.
========== ===== = ========== ===== =
@ -706,6 +829,9 @@ Media annotation
``scrobble`` ``scrobble``
✔️ ✔️
.. table::
:widths: 55 30 15
============== ===== = ============== ===== =
Parameter Vers. Parameter Vers.
============== ===== = ============== ===== =
@ -729,6 +855,9 @@ Sharing
``createShare`` ``createShare``
❌ ❌
.. table::
:widths: 55 30 15
=============== ===== = =============== ===== =
Parameter Vers. Parameter Vers.
=============== ===== = =============== ===== =
@ -742,6 +871,9 @@ Sharing
``updateShare`` ``updateShare``
❌ ❌
.. table::
:widths: 55 30 15
=============== ===== = =============== ===== =
Parameter Vers. Parameter Vers.
=============== ===== = =============== ===== =
@ -755,6 +887,9 @@ Sharing
``deleteShare`` ``deleteShare``
❌ ❌
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -769,6 +904,9 @@ Podcast
``getPodcasts`` ``getPodcasts``
❔ ❔
.. table::
:widths: 55 30 15
=================== ===== = =================== ===== =
Parameter Vers. Parameter Vers.
=================== ===== = =================== ===== =
@ -781,6 +919,9 @@ Podcast
``getNewestPodcasts`` ``getNewestPodcasts``
❔ 1.14.0 ❔ 1.14.0
.. table::
:widths: 55 30 15
========= ====== = ========= ====== =
Parameter Vers. Parameter Vers.
========= ====== = ========= ====== =
@ -799,6 +940,9 @@ Podcast
``createPodcastChannel`` ``createPodcastChannel``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -810,6 +954,9 @@ Podcast
``deletePodcastChannel`` ``deletePodcastChannel``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -821,6 +968,9 @@ Podcast
``deletePodcastEpisode`` ``deletePodcastEpisode``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -832,6 +982,9 @@ Podcast
``downloadPodcastEpisode`` ``downloadPodcastEpisode``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -846,6 +999,9 @@ Jukebox
``jukeboxControl`` ``jukeboxControl``
✔️ ✔️
.. table::
:widths: 55 30 15
========== ===== = ========== ===== =
Parameter Vers. Parameter Vers.
========== ===== = ========== ===== =
@ -871,6 +1027,9 @@ Internet radio
``createInternetRadioStation`` ``createInternetRadioStation``
❔ 1.16.0 ❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== = =============== ====== =
Parameter Vers. Parameter Vers.
=============== ====== = =============== ====== =
@ -884,6 +1043,9 @@ Internet radio
``updateInternetRadioStation`` ``updateInternetRadioStation``
❔ 1.16.0 ❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== = =============== ====== =
Parameter Vers. Parameter Vers.
=============== ====== = =============== ====== =
@ -898,6 +1060,9 @@ Internet radio
``deleteInternetRadioStation`` ``deleteInternetRadioStation``
❔ 1.16.0 ❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== = =============== ====== =
Parameter Vers. Parameter Vers.
=============== ====== = =============== ====== =
@ -912,6 +1077,9 @@ Chat
``getChatMessages`` ``getChatMessages``
✔️ ✔️
.. table::
:widths: 55 30 15
========= ===== = ========= ===== =
Parameter Vers. Parameter Vers.
========= ===== = ========= ===== =
@ -923,6 +1091,9 @@ Chat
``addChatMessage`` ``addChatMessage``
✔️ ✔️
.. table::
:widths: 55 30 15
=========== ===== = =========== ===== =
Parameter Vers. Parameter Vers.
=========== ===== = =========== ===== =
@ -937,6 +1108,9 @@ User management
``getUser`` ``getUser``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -955,6 +1129,9 @@ User management
``createUser`` ``createUser``
✔️ ✔️
.. table::
:widths: 55 30 15
======================= ====== = ======================= ====== =
Parameter Vers. Parameter Vers.
======================= ====== = ======================= ====== =
@ -982,6 +1159,9 @@ User management
``updateUser`` ``updateUser``
✔️ 1.10.2 ✔️ 1.10.2
.. table::
:widths: 55 30 15
======================= ====== = ======================= ====== =
Parameter Vers. Parameter Vers.
======================= ====== = ======================= ====== =
@ -1009,6 +1189,9 @@ User management
``deleteUser`` ``deleteUser``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -1020,6 +1203,9 @@ User management
``changePassword`` ``changePassword``
✔️ ✔️
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -1042,6 +1228,9 @@ Bookmarks
``createBookmark`` ``createBookmark``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
============ ===== = ============ ===== =
Parameter Vers. Parameter Vers.
============ ===== = ============ ===== =
@ -1055,6 +1244,9 @@ Bookmarks
``deleteBookmark`` ``deleteBookmark``
❔ 1.9.0 ❔ 1.9.0
.. table::
:widths: 55 30 15
=============== ===== = =============== ===== =
Parameter Vers. Parameter Vers.
=============== ===== = =============== ===== =
@ -1073,6 +1265,9 @@ Bookmarks
``savePlayQueue`` ``savePlayQueue``
❔ 1.12.0 ❔ 1.12.0
.. table::
:widths: 55 30 15
============ ====== = ============ ====== =
Parameter Vers. Parameter Vers.
============ ====== = ============ ====== =

2
docs/conf.py
View File

@ -30,7 +30,7 @@ html_theme_options = {
"github_user": "spl0k", "github_user": "spl0k",
"github_repo": "supysonic", "github_repo": "supysonic",
} }
html_static_path = [] html_static_path = ["_static"]
# Default alabaseter sidebars + localtoc # Default alabaseter sidebars + localtoc
html_sidebars = { html_sidebars = {