From a00b73a0c34a3acaa18c4476503c1a80ea3edc2e Mon Sep 17 00:00:00 2001 From: Tyler Date: Sat, 22 Apr 2017 22:41:31 -0400 Subject: [PATCH] More documentation fixes! --- docs/commands/media.rst | 9 +++++++- docs/conf.py | 5 +++-- docs/features/content.rst | 46 +++++++++++++++++++++++++++++++++++++++ docs/features/index.rst | 10 +++++++++ docs/index.rst | 22 +++++++++++-------- docs/setup.rst | 15 +++++++++++++ 6 files changed, 95 insertions(+), 12 deletions(-) create mode 100644 docs/features/content.rst create mode 100644 docs/features/index.rst create mode 100644 docs/setup.rst diff --git a/docs/commands/media.rst b/docs/commands/media.rst index f60d5cd..f702e6d 100644 --- a/docs/commands/media.rst +++ b/docs/commands/media.rst @@ -36,4 +36,11 @@ Or the text command: !!volume 0-100 -You can also say `louder` or `softer` to raise/lower the volume by 10% each time. \ No newline at end of file +You can also say `louder` or `softer` to raise/lower the volume by 10% each time. + +Setting the default volume +-------------------------- + +|project|'s default volume can be set for voice and media. The sane values of 100% for voice, and 20% for audio are used. When the command is used without arguments, it will show the current values. + + !!defaultvolume 0-100 \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7e06605..0c12ecf 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -153,5 +153,6 @@ texinfo_documents = [ 'Miscellaneous'), ] - - +rst_epilog =""" +.. |project| replace:: Astra +""" \ No newline at end of file diff --git a/docs/features/content.rst b/docs/features/content.rst new file mode 100644 index 0000000..244259a --- /dev/null +++ b/docs/features/content.rst @@ -0,0 +1,46 @@ +Content Creators +================ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Monitoring +---------- + +|project| can monitor Twitch.tv streams and YouTube to notify fans whenever you go live or post a new video! + +Content Channel +--------------- + +The Content Channel will be used every time |project| detects a channel change (Going live or a new published video). It will set it to the channel the command is said in, or a channel name starting with #. + +Usage: + + !!contentchannel [#channel] + +Tracking channels +----------------- + +To track a channel, use the `!!track` text command. + + !!track + +Untracking channels +------------------- + +To untrack a channel, use the `!!untrack` text command. + + !!untrack + +List tracked channels +--------------------- + +To list all channels monitored by the bot, use `!!tracked`. It will return a list of channels for Twitch and YouTube. + +Detection delay +--------------- + +Channel state changes on Twitch use Twitch's PubSub API, meaning near-instant updates of state. We also poll Twitch for statuses every minute like every other major bot. + +For YouTube, they officially support a protocol called PubSubHubbub. This gives instant notifications of published videos. \ No newline at end of file diff --git a/docs/features/index.rst b/docs/features/index.rst new file mode 100644 index 0000000..639a51a --- /dev/null +++ b/docs/features/index.rst @@ -0,0 +1,10 @@ +Features +======== + +.. toctree:: + :maxdepth: 2 + :glob: + :caption: Contents: + + * + diff --git a/docs/index.rst b/docs/index.rst index 6a271cd..d5b2810 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,28 +3,32 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Astra's documentation! -================================= +Astra - Next Generation Discord Bot +=================================== .. toctree:: :maxdepth: 1 :glob: :caption: Contents: + setup commands/index.rst + features/index.rst Features -------- - Voice commands -- Faster, more efficient features +- Faster and more efficient than other bots +- :doc:`Media Playback ` +- :doc:`Location, Time, and Weather ` -Using ------ +Development +----------- -Currently the bot cannot be used/invited to other servers. +Development on the bot is done randomly, but often. -Commands --------- +Setup/Options +------------- -A list of commands! \ No newline at end of file +See :doc:`setup`. \ No newline at end of file diff --git a/docs/setup.rst b/docs/setup.rst new file mode 100644 index 0000000..1a3c8d5 --- /dev/null +++ b/docs/setup.rst @@ -0,0 +1,15 @@ +Setup/Options +============= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Text Channel +------------ + +The Text Channel will be used every time |project| needs to output some text, but is currently playing media or saying something else. Think of it as a fallback channel. It will be set to whatever channel it is said in, or a channel name starting with #. + +Usage: + + !!textchannel [#channel]