Skip to content

Commit

Permalink
update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronhnsy committed Apr 23, 2022
1 parent db83c7b commit a9c7116
Show file tree
Hide file tree
Showing 8 changed files with 194 additions and 23 deletions.
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ From GitHub:
cd slate
python3.10 -m pip install .
Contents
--------
.. toctree::
:hidden:

pages/api
pages/examples
40 changes: 25 additions & 15 deletions docs/pages/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,35 +2,45 @@
API Reference
=============
placeholder text

Pool
^^^^
.. autoclass:: slate.Pool
:members:

Node
^^^^
----
.. autoclass:: slate.Node
:members:

Player
^^^^^^
------
.. autoclass:: slate.Player
:members:

Queue
^^^^^
-----
.. autoclass:: slate.Queue
:members:


Exceptions
----------
.. automodule:: slate.exceptions
:members:
Utils
-----

SPOTIFY_URL_REGEX
~~~~~~~~~~~~~~~~~
.. attribute:: slate.SPOTIFY_URL_REGEX

A regex that matches spotify URLs for tracks, albums, playlists, and artists.


MISSING
~~~~~~~
.. attribute:: slate.MISSING

A sentinel value that is used to indicate a missing value with distinction from :class:`None`.


.. toctree::
:maxdepth: 1
:glob:
:hidden:

objects
events
filters
enums
exceptions
19 changes: 19 additions & 0 deletions docs/pages/enums.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. py:currentmodule:: slate
Enums
=====

Provider
--------
.. autoclass:: slate.Provider
:members:

QueueLoopMode
-------------
.. autoclass:: slate.QueueLoopMode
:members:

Source
------
.. autoclass:: slate.Source
:members:
34 changes: 34 additions & 0 deletions docs/pages/events.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
.. py:currentmodule:: slate
Events
======

TrackStart
----------
.. autoclass:: slate.TrackStart
:members:

TrackEnd
--------
.. autoclass:: slate.TrackEnd
:members:

TrackStuck
----------
.. autoclass:: slate.TrackStuck
:members:

TrackException
--------------
.. autoclass:: slate.TrackException
:members:

WebsocketOpen
-------------
.. autoclass:: slate.WebsocketOpen
:members:

WebsocketClosed
---------------
.. autoclass:: slate.WebsocketClosed
:members:
5 changes: 0 additions & 5 deletions docs/pages/examples.rst

This file was deleted.

35 changes: 35 additions & 0 deletions docs/pages/exceptions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. py:currentmodule:: slate
Exceptions
==========

SlateError
----------
.. autoexception:: slate.SlateError

NodeConnectionError
-------------------
.. autoexception:: slate.NodeConnectionError

InvalidNodePassword
-------------------
.. autoexception:: slate.InvalidNodePassword

NodeNotConnected
----------------
.. autoexception:: slate.NodeNotConnected

HTTPError
---------
.. autoexception:: slate.HTTPError
:members:

NoResultsFound
--------------
.. autoexception:: slate.NoResultsFound
:members:

SearchFailed
------------
.. autoexception:: slate.SearchFailed
:members:
59 changes: 59 additions & 0 deletions docs/pages/filters.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
.. py:currentmodule:: slate
Filters
=======

BaseFilter
----------
.. autoclass:: slate.BaseFilter
:members:

Tremolo
-------
.. autoclass:: slate.Tremolo
:members:

Equalizer
---------
.. autoclass:: slate.Equalizer
:members:

Distortion
----------
.. autoclass:: slate.Distortion
:members:

Timescale
---------
.. autoclass:: slate.Timescale
:members:

Karaoke
-------
.. autoclass:: slate.Karaoke
:members:

ChannelMix
----------
.. autoclass:: slate.ChannelMix
:members:

Vibrato
-------
.. autoclass:: slate.Vibrato
:members:

Rotation
--------
.. autoclass:: slate.Rotation
:members:

LowPass
-------
.. autoclass:: slate.LowPass
:members:

Filter
------
.. autoclass:: slate.Filter
:members:
19 changes: 19 additions & 0 deletions docs/pages/objects.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
.. py:currentmodule:: slate
Objects
=======

Track
-----
.. autoclass:: slate.Track
:members:

Collection
----------
.. autoclass:: slate.Collection
:members:

Search
------
.. autoclass:: slate.Search
:members:

0 comments on commit a9c7116

Please sign in to comment.