Add initial documentation (#51)

.travis.yml

@@ -9,6 +9,8 @@ matrix:
   include:
     - python: 2.7
       env: TOXENV=flake8
+    - python: 2.7
+      env: TOXENV=docs
     - python: 2.7
       env: FIREFOX=nightly
       addons:
@@ -31,6 +33,8 @@ matrix:
         firefox: latest-esr
     - python: 3.5
       env: TOXENV=flake8
+    - python: 3.5
+      env: TOXENV=docs
     - python: 3.5
       env: TOXENV=coverage
       addons:

README.rst

@@ -1,7 +1,7 @@
 FoxPuppet
 =========
 
-Fox Puppet is a library for desktop firefox that provides ui interaction and state using the `Selenium <http://seleniumhq.org/>`_ library.
+FoxPuppet is a library for automating user interactions in `Firefox <https://www.mozilla.org/en-US/firefox/products/>`_ using `Selenium <http://seleniumhq.org/>`_.
 
 .. image:: https://img.shields.io/badge/license-MPL%202.0-blue.svg
    :target: https://github.com/mozilla/FoxPuppet/blob/master/LICENSE

docs/.gitignore

@@ -0,0 +1 @@
+_build

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = FoxPuppet
+SOURCEDIR     = .
+BUILDDIR      = _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)

docs/conf.py

@@ -0,0 +1,156 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# FoxPuppet documentation build configuration file, created by
+# sphinx-quickstart on Thu Jan  5 12:25:16 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 = ['sphinx.ext.autodoc',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode']
+
+# 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 = 'FoxPuppet'
+copyright = '2017, Mozilla'
+author = 'Mozilla'
+
+# 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 = 'latest'
+# The full version, including alpha/beta/rc tags.
+release = 'latest'
+
+# 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 = True
+
+
+# -- 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 = 'FoxPuppetdoc'
+
+
+# -- 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, 'FoxPuppet.tex', 'FoxPuppet Documentation',
+     'Mozilla', '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, 'foxpuppet', 'FoxPuppet 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, 'FoxPuppet', 'FoxPuppet Documentation',
+     author, 'FoxPuppet', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/development.rst

@@ -0,0 +1,28 @@
+Development
+===========
+
+Automated Testing
+-----------------
+
+All pull requests and merges are tested in `Travis CI <https://travis-ci.org/>`_
+based on the ``.travis.yml`` file.
+
+Usually, a link to your specific travis build appears in pull requests, but if
+not, you can find it on the
+`pull requests page <https://travis-ci.org/pytest-dev/pytest-selenium/pull_requests>`_
+
+The only way to trigger Travis CI to run again for a pull request, is to submit
+another change to the pull branch.
+
+Test coverage is done by `Coveralls <https://coveralls.io/>`_. 
+
+Running Tests
+-------------
+
+You will need `Tox <http://tox.testrun.org/>`_ installed to run the tests
+against the supported Python versions.
+
+.. code-block:: bash
+
+  $ pip install tox
+  $ tox

docs/index.rst

@@ -0,0 +1,13 @@
+
+FoxPuppet
+=========
+
+FoxPuppet is a library for automating user interactions in `Firefox <https://www.mozilla.org/en-US/firefox/products/>`_ using `Selenium <http://seleniumhq.org/>`_.
+
+.. toctree::
+   :maxdepth: 2
+
+   installing
+   user_guide
+   development
+   news

docs/installing.rst

@@ -0,0 +1,20 @@
+Installation
+============
+
+Requirements
+------------
+FoxPuppet will work with python 2.7, and 3.5
+
+Install FoxPuppet
+-----------------
+To install FoxPuppet using `pip <https://pip.pypa.io/>`_:
+
+.. code-block:: bash
+
+  $ pip install FoxPuppet
+
+To install from source:
+
+.. code-block:: bash
+
+  $ python setup.py develop

docs/news.rst

@@ -0,0 +1,2 @@
+Release Notes
+=============

docs/user_guide.rst

@@ -0,0 +1,2 @@
+User Guide
+==========

tox.ini

@@ -13,10 +13,18 @@ commands =
     pytest --driver Firefox --cov {posargs}
     coveralls
 
+[testenv:docs]
+changedir = docs
+deps = sphinx
+commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html
+
 [testenv:flake8]
 skip_install = true
 deps = -rrequirements/flake8.txt
 commands = flake8 {posargs:.}
 
+[flake8]
+exclude = .tox,docs
+
 [pytest]
 testpaths = tests