More documentation fixes!

This commit is contained in:
Tyler 2017-04-22 22:41:31 -04:00
parent 6944755ebf
commit a00b73a0c3
6 changed files with 95 additions and 12 deletions

View File

@ -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.
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 <voice/media> 0-100

View File

@ -153,5 +153,6 @@ texinfo_documents = [
'Miscellaneous'),
]
rst_epilog ="""
.. |project| replace:: Astra
"""

46
docs/features/content.rst Normal file
View File

@ -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 <twitch/youtube> <channel name>
Untracking channels
-------------------
To untrack a channel, use the `!!untrack` text command.
!!untrack <twitch/youtube> <channel name>
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.

10
docs/features/index.rst Normal file
View File

@ -0,0 +1,10 @@
Features
========
.. toctree::
:maxdepth: 2
:glob:
:caption: Contents:
*

View File

@ -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 <commands/media>`
- :doc:`Location, Time, and Weather <commands/location>`
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!
See :doc:`setup`.

15
docs/setup.rst Normal file
View File

@ -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]