diff --git a/docs/docs_channel.rst b/docs/docs_channel.rst new file mode 100644 index 000000000..a0e64a5eb --- /dev/null +++ b/docs/docs_channel.rst @@ -0,0 +1,21 @@ +.. include:: ./vars.rst + +Channel +======= + +**extends** Equality_ + +The Channel class is the base class for all types of channel. + +Attributes +---------- + +id +~~ + +The ID of the channel, a `String`. + +client +~~~~~~ + +The Client_ that cached the channel. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 3b8c21e9e..03c1218fb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,12 @@ Contents: .. _docs: +.. toctree:: + :maxdepth: 2 + :caption: Channel Documentation + + docs_channel + .. toctree:: :maxdepth: 2 :caption: Documentation diff --git a/docs/vars.rst b/docs/vars.rst index 67d4586b5..a32e3d844 100644 --- a/docs/vars.rst +++ b/docs/vars.rst @@ -2,5 +2,6 @@ .. _Cache : ./docs_cache.html .. _User : ./docs_user.html .. _Server : ./docs_server.html +.. _Channel : ./docs_channel.html .. _Promises : https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Promise .. _EventEmitter : https://nodejs.org/api/events.html#events_class_events_eventemitter \ No newline at end of file