First test version

This commit is contained in:
Tyler 2017-04-22 21:06:45 -04:00
commit 6944755ebf
7 changed files with 298 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/docs/_build

20
docs/Makefile Normal file
View File

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = Astra
SOURCEDIR = .
BUILDDIR = /var/www/_build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

19
docs/commands/index.rst Normal file
View File

@ -0,0 +1,19 @@
Commands
========
.. toctree::
:maxdepth: 2
:glob:
:caption: Contents:
*
Voice Commands
--------------
Voice Commands are matched by full words/blocks of text, such as holding down the push to talk for only the command.
Text Commands
-------------
Text Commands can be done in any channel with the prefix `!!` (two exclamation points).

View File

@ -0,0 +1,32 @@
Location, Time, and Weather
===========================
Location
--------
Setting your location can provide responses to many commands that are tailored to your location, such as the time trigger returning the time in your timezone, or weather for your hometown.
To set your location, use the following text command:
!!location city/state/country
We use Google's Location API to resolve this to a Latitude/Longitude, which you can get by using `!!location` without any arguments after setting it.
Time
----
You can get the current time by saying:
what time is it
This will use either GMT or the timezone for your specified location.
Weather
-------
The weather command requires you to set your location, as seen above.
You can get the current weather for your location by saying:
what's the weather like

39
docs/commands/media.rst Normal file
View File

@ -0,0 +1,39 @@
Media Commands
==============
.. toctree::
:maxdepth: 2
:caption: Contents:
Playing Media
-------------
Playing media can be done using the voice command
play <query>
You can also add YouTube videos directly using the text command:
!!play <url or query>
Controlling the queue
---------------------
Queue items can be skipped by saying `skip` or using the text command `!!skip`.
The queue can be cleared by using the text command `!!clear`. This will not skip the current song.
To stop playback and clear the queue, say `stop` or use the text command `!!stop`.
Adjusting the volume
--------------------
Adjusting the volume can be done using the voice command:
volume 0-100
Or the text command:
!!volume 0-100
You can also say `louder` or `softer` to raise/lower the volume by 10% each time.

157
docs/conf.py Normal file
View File

@ -0,0 +1,157 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Astra documentation build configuration file, created by
# sphinx-quickstart on Sun Apr 23 00:32:30 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = 'Astra'
copyright = '2017, Meow.tf'
author = 'Meow.tf'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'Astradoc'
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'Astra.tex', 'Astra Documentation',
'Meow.tf', 'manual'),
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'astra', 'Astra Documentation',
[author], 1)
]
# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'Astra', 'Astra Documentation',
author, 'Astra', 'One line description of project.',
'Miscellaneous'),
]

30
docs/index.rst Normal file
View File

@ -0,0 +1,30 @@
.. Astra documentation master file, created by
sphinx-quickstart on Sun Apr 23 00:32:30 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Astra's documentation!
=================================
.. toctree::
:maxdepth: 1
:glob:
:caption: Contents:
commands/index.rst
Features
--------
- Voice commands
- Faster, more efficient features
Using
-----
Currently the bot cannot be used/invited to other servers.
Commands
--------
A list of commands!