Merge pull request #1 from Syndace/docs

Merge documentation

.gitignore

@@ -5,4 +5,4 @@ X3DH.egg-info/
 
 .pytest_cache/
 
-*.tmp
+docs/_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    = X3DH
+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,165 @@
+# -*- 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
+
+this_file_path = os.path.dirname(os.path.abspath(__file__))
+sys.path.append(os.path.join(this_file_path, ".."))
+sys.path.append(os.path.join(this_file_path, "..", "x3dh"))
+
+import version
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'X3DH'
+copyright = '2018, Tim Henkes'
+author = 'Tim Henkes'
+
+# The short X.Y version
+version = version.__version__
+# The full version, including alpha/beta/rc tags
+release = version
+
+
+# -- 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.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'
+
+# 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 = "sphinx_rtd_theme"
+
+# 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 = 'X3DHdoc'
+
+
+# -- 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, 'X3DH.tex', 'X3DH Documentation',
+     'Tim Henkes', '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, 'x3dh', 'X3DH 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, 'X3DH', 'X3DH Documentation',
+     author, 'X3DH', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------

docs/index.rst

@@ -0,0 +1,12 @@
+X3DH - A python implementation of the Extended Triple Diffie-Hellman key agreement protocol.
+============================================================================================
+
+.. toctree::
+    Package: x3dh <x3dh/package>
+
+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=X3DH
+
+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/x3dh/exceptions/invalidconfigurationexception.rst

@@ -0,0 +1,9 @@
+invalidconfigurationexception
+=============================
+
+.. autoclass:: x3dh.exceptions.InvalidConfigurationException
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/exceptions/keyexchangeexception.rst

@@ -0,0 +1,9 @@
+keyexchangeexception
+====================
+
+.. autoclass:: x3dh.exceptions.KeyExchangeException
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/exceptions/missingkeyexception.rst

@@ -0,0 +1,9 @@
+missingkeyexception
+===================
+
+.. autoclass:: x3dh.exceptions.MissingKeyException
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/exceptions/package.rst

@@ -0,0 +1,7 @@
+exceptions
+==========
+
+.. toctree::
+    Module: invalidconfigurationexception <invalidconfigurationexception>
+    Module: keyexchangeexception <keyexchangeexception>
+    Module: missingkeyexception <missingkeyexception>

docs/x3dh/implementations/keypaircurve25519.rst

@@ -0,0 +1,9 @@
+keypaircurve25519
+=================
+
+.. autoclass:: x3dh.implementations.KeyPairCurve25519
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/implementations/package.rst

@@ -0,0 +1,5 @@
+implementations
+===============
+
+.. toctree::
+    Module: keypaircurve25519 <keypaircurve25519>

docs/x3dh/keypair.rst

@@ -0,0 +1,9 @@
+keypair
+=======
+
+.. autoclass:: x3dh.KeyPair
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/package.rst

@@ -0,0 +1,11 @@
+x3dh
+====
+
+.. toctree::
+    Module: keypair <keypair>
+    Module: publicbundle <publicbundle>
+    Module: publickeyencoder <publickeyencoder>
+    Module: state <state>
+
+    Package: exceptions <exceptions/package>
+    Package: implementations <implementations/package>

docs/x3dh/publicbundle.rst

@@ -0,0 +1,9 @@
+publicbundle
+============
+
+.. autoclass:: x3dh.PublicBundle
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/publickeyencoder.rst

@@ -0,0 +1,9 @@
+publickeyencoder
+================
+
+.. autoclass:: x3dh.PublicKeyEncoder
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

docs/x3dh/state.rst

@@ -0,0 +1,9 @@
+state
+=====
+
+.. autoclass:: x3dh.State
+    :members:
+    :special-members:
+    :member-order: bysource
+    :exclude-members: __dict__, __weakref__, __module__
+    :show-inheritance:

requirements.txt

@@ -1,2 +1,2 @@
 hkdf==0.0.3
-XEdDSA>=0.4.0
+XEdDSA>=0.4.1