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;
}

403
docs/api.rst
View File

@ -30,119 +30,128 @@ or with version 1.8.0.
All methods / pseudo-TOC
^^^^^^^^^^^^^^^^^^^^^^^^
=========================== ====== =
Method Vers.
=========================== ====== =
ping_ ✔️
getLicense_ ✔️
getMusicFolders_ ✔️
getIndexes_ ✔️
getMusicDirectory_ ✔️
getGenres_ 1.9.0 ✔️
getArtists_ ✔️
getArtist_ ✔️
getAlbum_ ✔️
getSong_ ✔️
getVideos_ ❌
getVideoInfo_ 1.15.0 🔴
getArtistInfo_ 1.11.0 📅
getArtistInfo2_ 1.11.0 📅
getAlbumInfo_ 1.14.0 📅
getAlbumInfo2_ 1.14.0 📅
getSimilarSongs_ 1.11.0 ❔
getSimilarSongs2_ 1.11.0 ❔
getTopSongs_ 1.13.0 ❔
getAlbumList_ ✔️
getAlbumList2_ ✔️
getRandomSongs_ ✔️
getSongsByGenre_ 1.9.0 ✔️
getNowPlaying_ ✔️
getStarred_ ✔️
getStarred2_ ✔️
:ref:`search <search->` ✔️
search2_ ✔️
search3_ ✔️
getPlaylists_ ✔️
getPlaylist_ ✔️
createPlaylist_ ✔️
updatePlaylist_ ✔️
deletePlaylist_ ✔️
stream_ ✔️
download_ ✔️
hls_ 1.9.0 🔴
getCaptions_ 1.15.0 🔴
getCoverArt_ ✔️
getLyrics_ ✔️
getAvatar_ ❌
star_ ✔️
unstar_ ✔️
setRating_ ✔️
scrobble_ ✔️
getShares_ ❌
createShare_ ❌
updateShare_ ❌
deleteShare_ ❌
getPodcasts_ ❔
getNewestPodcasts_ 1.14.0 ❔
refreshPodcasts_ 1.9.0 ❔
createPodcastChannel_ 1.9.0 ❔
deletePodcastChannel_ 1.9.0 ❔
deletePodcastEpisode_ 1.9.0 ❔
downloadPodcastEpisode_ 1.9.0 ❔
jukeboxControl_ ✔️
getInternetRadioStations_ 1.9.0 ✔️
createInternetRadioStation_ 1.16.0 ✔️
updateInternetRadioStation_ 1.16.0 ✔️
deleteInternetRadioStation_ 1.16.0 ✔️
getChatMessages_ ✔️
addChatMessage_ ✔️
getUser_ ✔️
getUsers_ 1.9.0 ✔️
createUser_ ✔️
updateUser_ 1.10.2 ✔️
deleteUser_ ✔️
changePassword_ ✔️
getBookmarks_ 1.9.0 ❔
createBookmark_ 1.9.0 ❔
deleteBookmark_ 1.9.0 ❔
getPlayQueue_ 1.12.0 ❔
savePlayQueue_ 1.12.0 ❔
getScanStatus_ 1.15.0 ✔️
startScan_ 1.15.0 ✔️
=========================== ====== =
.. table::
:widths: 55 30 15
=========================== ====== =
Method Vers.
=========================== ====== =
ping_ ✔️
getLicense_ ✔️
getMusicFolders_ ✔️
getIndexes_ ✔️
getMusicDirectory_ ✔️
getGenres_ 1.9.0 ✔️
getArtists_ ✔️
getArtist_ ✔️
getAlbum_ ✔️
getSong_ ✔️
getVideos_ ❌
getVideoInfo_ 1.15.0 🔴
getArtistInfo_ 1.11.0 📅
getArtistInfo2_ 1.11.0 📅
getAlbumInfo_ 1.14.0 📅
getAlbumInfo2_ 1.14.0 📅
getSimilarSongs_ 1.11.0 ❔
getSimilarSongs2_ 1.11.0 ❔
getTopSongs_ 1.13.0 ❔
getAlbumList_ ✔️
getAlbumList2_ ✔️
getRandomSongs_ ✔️
getSongsByGenre_ 1.9.0 ✔️
getNowPlaying_ ✔️
getStarred_ ✔️
getStarred2_ ✔️
:ref:`search <search->` ✔️
search2_ ✔️
search3_ ✔️
getPlaylists_ ✔️
getPlaylist_ ✔️
createPlaylist_ ✔️
updatePlaylist_ ✔️
deletePlaylist_ ✔️
stream_ ✔️
download_ ✔️
hls_ 1.9.0 🔴
getCaptions_ 1.15.0 🔴
getCoverArt_ ✔️
getLyrics_ ✔️
getAvatar_ ❌
star_ ✔️
unstar_ ✔️
setRating_ ✔️
scrobble_ ✔️
getShares_ ❌
createShare_ ❌
updateShare_ ❌
deleteShare_ ❌
getPodcasts_ ❔
getNewestPodcasts_ 1.14.0 ❔
refreshPodcasts_ 1.9.0 ❔
createPodcastChannel_ 1.9.0 ❔
deletePodcastChannel_ 1.9.0 ❔
deletePodcastEpisode_ 1.9.0 ❔
downloadPodcastEpisode_ 1.9.0 ❔
jukeboxControl_ ✔️
getInternetRadioStations_ 1.9.0 ✔️
createInternetRadioStation_ 1.16.0 ✔️
updateInternetRadioStation_ 1.16.0 ✔️
deleteInternetRadioStation_ 1.16.0 ✔️
getChatMessages_ ✔️
addChatMessage_ ✔️
getUser_ ✔️
getUsers_ 1.9.0 ✔️
createUser_ ✔️
updateUser_ 1.10.2 ✔️
deleteUser_ ✔️
changePassword_ ✔️
getBookmarks_ 1.9.0 ❔
createBookmark_ 1.9.0 ❔
deleteBookmark_ 1.9.0 ❔
getPlayQueue_ 1.12.0 ❔
savePlayQueue_ 1.12.0 ❔
getScanStatus_ 1.15.0 ✔️
startScan_ 1.15.0 ✔️
=========================== ====== =
Global
^^^^^^
Parameters used for any request
===== ====== =
P. Vers.
===== ====== =
``u`` ✔️
``p`` ✔️
``t`` 1.13.0 🔴
``s`` 1.13.0 🔴
``v`` ✔️
``c`` ✔️
``f`` ✔️
===== ====== =
.. table::
:widths: 55 30 15
===== ====== =
P. Vers.
===== ====== =
``u`` ✔️
``p`` ✔️
``t`` 1.13.0 🔴
``s`` 1.13.0 🔴
``v`` ✔️
``c`` ✔️
``f`` ✔️
===== ====== =
Error codes
== ====== =
# Vers.
== ====== =
0 ✔️
10 ✔️
20 ✔️
30 ✔️
40 ✔️
41 1.15.0 📅
50 ✔️
60 ✔️
70 ✔️
== ====== =
.. table::
:widths: 55 30 15
== ====== =
# Vers.
== ====== =
0 ✔️
10 ✔️
20 ✔️
30 ✔️
40 ✔️
41 1.15.0 📅
50 ✔️
60 ✔️
70 ✔️
== ====== =
System
^^^^^^
@ -176,6 +185,9 @@ Browsing
``getIndexes``
✔️
.. table::
:widths: 55 30 15
=================== ===== =
Parameter Vers.
=================== ===== =
@ -188,6 +200,9 @@ Browsing
``getMusicDirectory``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -206,6 +221,9 @@ Browsing
``getArtists``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -217,6 +235,9 @@ Browsing
``getArtist``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -228,6 +249,9 @@ Browsing
``getAlbum``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -239,6 +263,9 @@ Browsing
``getSong``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -257,6 +284,9 @@ Browsing
``getVideoInfo``
🔴 1.15.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -268,6 +298,9 @@ Browsing
``getArtistInfo``
📅 1.11.0
.. table::
:widths: 55 30 15
===================== ====== =
Parameter Vers.
===================== ====== =
@ -281,6 +314,9 @@ Browsing
``getArtistInfo2``
📅 1.11.0
.. table::
:widths: 55 30 15
===================== ====== =
Parameter Vers.
===================== ====== =
@ -294,6 +330,9 @@ Browsing
``getAlbumInfo``
📅 1.14.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -305,6 +344,9 @@ Browsing
``getAlbumInfo2``
📅 1.14.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -316,6 +358,9 @@ Browsing
``getSimilarSongs``
❔ 1.11.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -328,6 +373,9 @@ Browsing
``getSimilarSongs2``
❔ 1.11.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -340,6 +388,9 @@ Browsing
``getTopSongs``
❔ 1.13.0
.. table::
:widths: 55 30 15
========== ====== =
Parameter Vers.
========== ====== =
@ -355,6 +406,9 @@ Album/song lists
``getAlbumList``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -375,6 +429,9 @@ Album/song lists
``getAlbumList2``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -395,6 +452,9 @@ Album/song lists
``getRandomSongs``
✔️
.. table::
:widths: 55 30 15
================= ===== =
Parameter Vers.
================= ===== =
@ -410,6 +470,9 @@ Album/song lists
``getSongsByGenre``
✔️ 1.9.0
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -431,6 +494,9 @@ Album/song lists
``getStarred``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -442,6 +508,9 @@ Album/song lists
``getStarred2``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -456,6 +525,9 @@ Searching
``search``
✔️
.. table::
:widths: 55 30 15
============= ===== =
Parameter Vers.
============= ===== =
@ -473,6 +545,9 @@ Searching
``search2``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -491,6 +566,9 @@ Searching
``search3``
✔️
.. table::
:widths: 55 30 15
================= ====== =
Parameter Vers.
================= ====== =
@ -512,6 +590,9 @@ Playlists
``getPlaylists``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -523,6 +604,9 @@ Playlists
``getPlaylist``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -534,6 +618,9 @@ Playlists
``createPlaylist``
✔️
.. table::
:widths: 55 30 15
============== ===== =
Parameter Vers.
============== ===== =
@ -547,6 +634,9 @@ Playlists
``updatePlaylist``
✔️
.. table::
:widths: 55 30 15
===================== ===== =
Parameter Vers.
===================== ===== =
@ -563,6 +653,9 @@ Playlists
``deletePlaylist``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -577,6 +670,9 @@ Media retrieval
``stream``
✔️
.. table::
:widths: 55 30 15
========================= ====== =
Parameter Vers.
========================= ====== =
@ -594,6 +690,9 @@ Media retrieval
``download``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -605,6 +704,9 @@ Media retrieval
``hls``
🔴 1.9.0
.. table::
:widths: 55 30 15
============== ====== =
Parameter Vers.
============== ====== =
@ -618,6 +720,9 @@ Media retrieval
``getCaptions``
🔴 1.15.0
.. table::
:widths: 55 30 15
========== ====== =
Parameter Vers.
========== ====== =
@ -630,6 +735,9 @@ Media retrieval
``getCoverArt``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -642,6 +750,9 @@ Media retrieval
``getLyrics``
✔️
.. table::
:widths: 55 30 15
========== ===== =
Parameter Vers.
========== ===== =
@ -654,6 +765,9 @@ Media retrieval
``getAvatar``
❌
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -668,6 +782,9 @@ Media annotation
``star``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -681,6 +798,9 @@ Media annotation
``unstar``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -694,6 +814,9 @@ Media annotation
``setRating``
✔️
.. table::
:widths: 55 30 15
========== ===== =
Parameter Vers.
========== ===== =
@ -706,6 +829,9 @@ Media annotation
``scrobble``
✔️
.. table::
:widths: 55 30 15
============== ===== =
Parameter Vers.
============== ===== =
@ -729,6 +855,9 @@ Sharing
``createShare``
❌
.. table::
:widths: 55 30 15
=============== ===== =
Parameter Vers.
=============== ===== =
@ -742,6 +871,9 @@ Sharing
``updateShare``
❌
.. table::
:widths: 55 30 15
=============== ===== =
Parameter Vers.
=============== ===== =
@ -755,6 +887,9 @@ Sharing
``deleteShare``
❌
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -769,6 +904,9 @@ Podcast
``getPodcasts``
❔
.. table::
:widths: 55 30 15
=================== ===== =
Parameter Vers.
=================== ===== =
@ -781,6 +919,9 @@ Podcast
``getNewestPodcasts``
❔ 1.14.0
.. table::
:widths: 55 30 15
========= ====== =
Parameter Vers.
========= ====== =
@ -799,6 +940,9 @@ Podcast
``createPodcastChannel``
❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -810,6 +954,9 @@ Podcast
``deletePodcastChannel``
❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -821,6 +968,9 @@ Podcast
``deletePodcastEpisode``
❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -832,6 +982,9 @@ Podcast
``downloadPodcastEpisode``
❔ 1.9.0
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -846,6 +999,9 @@ Jukebox
``jukeboxControl``
✔️
.. table::
:widths: 55 30 15
========== ===== =
Parameter Vers.
========== ===== =
@ -871,6 +1027,9 @@ Internet radio
``createInternetRadioStation``
❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== =
Parameter Vers.
=============== ====== =
@ -884,6 +1043,9 @@ Internet radio
``updateInternetRadioStation``
❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== =
Parameter Vers.
=============== ====== =
@ -898,6 +1060,9 @@ Internet radio
``deleteInternetRadioStation``
❔ 1.16.0
.. table::
:widths: 55 30 15
=============== ====== =
Parameter Vers.
=============== ====== =
@ -912,6 +1077,9 @@ Chat
``getChatMessages``
✔️
.. table::
:widths: 55 30 15
========= ===== =
Parameter Vers.
========= ===== =
@ -923,6 +1091,9 @@ Chat
``addChatMessage``
✔️
.. table::
:widths: 55 30 15
=========== ===== =
Parameter Vers.
=========== ===== =
@ -937,6 +1108,9 @@ User management
``getUser``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -955,6 +1129,9 @@ User management
``createUser``
✔️
.. table::
:widths: 55 30 15
======================= ====== =
Parameter Vers.
======================= ====== =
@ -982,6 +1159,9 @@ User management
``updateUser``
✔️ 1.10.2
.. table::
:widths: 55 30 15
======================= ====== =
Parameter Vers.
======================= ====== =
@ -1009,6 +1189,9 @@ User management
``deleteUser``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -1020,6 +1203,9 @@ User management
``changePassword``
✔️
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -1042,6 +1228,9 @@ Bookmarks
``createBookmark``
❔ 1.9.0
.. table::
:widths: 55 30 15
============ ===== =
Parameter Vers.
============ ===== =
@ -1055,6 +1244,9 @@ Bookmarks
``deleteBookmark``
❔ 1.9.0
.. table::
:widths: 55 30 15
=============== ===== =
Parameter Vers.
=============== ===== =
@ -1073,6 +1265,9 @@ Bookmarks
``savePlayQueue``
❔ 1.12.0
.. table::
:widths: 55 30 15
============ ====== =
Parameter Vers.
============ ====== =

2
docs/conf.py
View File

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