Add sphinx and contribution guide to documentation

.gitignore

@@ -30,5 +30,10 @@ venv
 # Coverage
 .coverage*
 
+# Sphinx
+_build/
+_static/
+_templates/
+
 # Pycharm
 .idea

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    = lti
+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/class_reference.rst

@@ -0,0 +1,9 @@
+Class Reference
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   tool_config
+   tool_provider
+   tool_consumer

docs/conf.py

@@ -0,0 +1,158 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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('../src'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'lti'
+copyright = '2018, Python LTI Initiative'
+author = 'Python LTI Initiative'
+
+# The short X.Y version
+version = ''
+# The full version, including alpha/beta/rc tags
+release = '0.9.3'
+
+
+# -- 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',
+]
+
+# 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'
+
+# 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 pattern also affects 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'
+
+
+# -- 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 = 'classic'
+
+# 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']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'ltidoc'
+
+
+# -- 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, 'lti.tex', 'lti Documentation',
+     'Python LTI Initiative', '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, 'lti', 'lti 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, 'lti', 'lti Documentation',
+     author, 'lti', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

docs/contributing.rst

@@ -0,0 +1,70 @@
+Contributing
+============
+
+Setup development environment
+-----------------------------
+
+If you decide to contribute to the code base, you'll first have to fork the project on GitHub, and then clone the project in the local environment. You'll need a GitHub account in order to make a fork.
+
+First make a directory, setup virtualenv, and install dependencies:
+
+.. code-block:: sh
+
+    mkdir pylti
+    cd pylti
+    pipenv --three
+    pipenv install lxml oauthlib requests-oauthlib
+    pipenv install tox sphinx --dev
+
+Now that you have setup the development environment, you're ready to clone the project (just replace `<your_github_username>` with your actual GitHub username):
+
+.. code-block:: sh
+
+    git clone https://github.com/<your_github_username>/lti.git lti
+
+For testing, you can build and install library using `setup.py` (but this is not really needed or recommended, as you'll see later):
+
+.. code-block:: sh
+
+    cd lti
+    python setup.py bdist_wheel
+    pipenv install dist/lti-0.9.3.whl
+
+or you can let `tox` handle the build process (it will build and execute automated tests):
+
+.. code-block:: sh
+
+    cd lti
+    tox
+
+If you want to contribute to documentation, you can build the documentation locally:
+
+.. code-block:: sh
+
+    cd lti/docs
+    make html
+
+Now that you have the development environment all setup, it's best to make a new branch for your feature (or bug fix!), and make changes there:
+
+.. code-block:: sh
+
+    git checkout -b my_new_feature
+
+When you finish coding, use `tox` to test the changes. If all is good, push the branch to your fork, and make a pull request.
+
+Keeping your fork synced with upstream
+--------------------------------------
+
+If you followed the previously described setup, then you can easily keep your fork up-to-date with the original repository. First, you need to add the upstream repository to your project:
+
+.. code-block:: sh
+
+    git remote add upstream https://github.com/pylti/lti.git
+
+Then, you can fetch the changes made to the master, and then push them to your fork:
+
+.. code-block:: sh
+
+    git fetch upstream
+    git merge upstream/master
+    git push origin master

docs/examples.rst

@@ -0,0 +1,5 @@
+Examples
+========
+
+.. toctree::
+   :maxdepth: 2

docs/getting_started.rst

@@ -0,0 +1,42 @@
+Getting Started
+===============
+
+`lti` is a Python library implementing the Learning Tools Interperability (LTI) standard. It is based on dce_lti_py_, which is based on ims_lti_py_.
+
+.. _dce_lti_py: https://github.com/harvard-dce/dce_lti_py
+.. _ims_lti_py: https://github.com/tophatmonocle/ims_lti_py
+
+Installation
+------------
+
+You can install the library using `pip`:
+
+.. code-block:: sh
+
+    pip install lti
+
+Or `pipenv`:
+
+.. code-block:: sh
+
+    pipenv install lti
+
+Usage
+-----
+
+The primary goal of this library is to provide classes for building Python LTI tool providers (LTI apps). To that end, the functionality that you're looking for is probably in the `ToolConfig` and `ToolProvider` classes (`ToolConsumer` is available too, if you want to consume LTI Providers).
+
+For more info on how to use these classes, look at the examples_.
+
+.. _examples: ./examples.html
+
+Dependencies
+------------
+
+* lxml_
+* oauthlib_
+* requests-oauthlib_
+
+.. _lxml: https://github.com/lxml/lxml
+.. _oauthlib: https://github.com/idan/oauthlib
+.. _requests-oauthlib: https://github.com/requests/requests-oauthlib

docs/index.rst

@@ -0,0 +1,24 @@
+.. lti documentation master file, created by
+   sphinx-quickstart on Sun Jul 22 15:52:38 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to lti's documentation!
+===============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started
+   examples
+   contributing
+   class_reference
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=lti
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/tool_config.rst

@@ -0,0 +1,5 @@
+ToolConfig
+==========
+
+.. automodule:: lti.tool_config
+   :members: