Merge pull request #10 from timthelion/docs

Add basic documentation

.gitignore

@@ -6,3 +6,5 @@ python_trezor.egg-info/
 *.py.cache
 distribute-*.egg
 distribute-*.tar.gz
+docs/_build
+docs/.docs-build-environment

docs/Dockerfile

@@ -0,0 +1,3 @@
+FROM debian
+RUN apt-get update && apt-get install -y python-pip cython python-dev libusb-1.0-0-dev python-qt4 libudev-dev
+RUN pip install sphinx ecdsa protobuf mnemonic hidapi pyserial requests

docs/Makefile

@@ -0,0 +1,12 @@
+.docs-build-environment: Dockerfile
+	docker build -t python-trezor-docs-build-environment .
+	touch .docs-build-environment
+
+shell: .docs-build-environment
+	docker run -i -t -v $(subst $(notdir $(CURDIR)),,$(CURDIR)):/root -w /root python-trezor-docs-build-environment /bin/bash
+
+html:
+	sphinx-build -b html . ./_build/
+
+clean:
+	rm -rf _build/

docs/client-BaseClient.rst

@@ -0,0 +1,6 @@
+BaseClient class
+--------------
+
+.. autoclass:: trezorlib.client.BaseClient
+ :members:
+ :undoc-members:

docs/client-ProtocolMixin.rst

@@ -0,0 +1,6 @@
+ProtocolMixin class
+-----------------
+
+.. autoclass:: trezorlib.client.ProtocolMixin
+ :members:
+ :undoc-members:

docs/client-TextUIMixin.rst

@@ -0,0 +1,6 @@
+TextUIMixin class
+------------------
+
+.. autoclass:: trezorlib.client.TextUIMixin
+ :members:
+ :undoc-members:

docs/client.rst

@@ -0,0 +1,18 @@
+TrezorClient class
+----------------
+
+TrezorClient objects allow us to interact with TREZOR devices.
+
+.. autoclass:: trezorlib.client.TrezorClient
+ :members:
+ :undoc-members:
+
+The TrezorClient class inherits from three base classes:
+
+.. toctree::
+   :maxdepth: 2
+
+   client-ProtocolMixin
+   client-BaseClient
+   client-TextUIMixin
+

docs/conf.py

@@ -0,0 +1,263 @@
+# -*- coding: utf-8 -*-
+#
+# TREZOR Python API documentation build configuration file, created by
+# sphinx-quickstart on Thu Aug 21 14:42:32 2014.
+#
+# 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.
+
+import sys
+import os
+
+sys.path.append("/root/")
+
+# 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.
+#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.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'TREZOR Python API'
+copyright = u'2014, SatoshiLabs'
+
+# 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 = '0'
+# The full version, including alpha/beta/rc tags.
+release = '0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = 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 = 'default'
+
+# 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 themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# 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']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+#html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TREZORPythonAPIdoc'
+
+
+# -- 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': '',
+}
+
+# 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 = [
+  ('index', 'TREZORPythonAPI.tex', u'TREZOR Python API Documentation',
+   u'SatoshiLabs', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'trezorpythonapi', u'TREZOR Python API Documentation',
+     [u'SatoshiLabs'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- 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 = [
+  ('index', 'TREZORPythonAPI', u'TREZOR Python API Documentation',
+   u'SatoshiLabs', 'TREZORPythonAPI', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False

docs/index.rst

@@ -0,0 +1,26 @@
+.. TREZOR Python API documentation master file, created by
+   sphinx-quickstart on Thu Aug 21 14:42:32 2014.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to TREZOR Python API's documentation!
+=============================================
+
+Contents:
+
+The Python TREZOR API is a comprehensive API which covers all aspects of communicating with your TREZOR device.  It includes tools for connecting to the TREZOR using a varienty of transport methods, displaying standard TREZOR GUI elements, and debugging programs which use the API using moc up TREZOR devices.
+
+.. toctree::
+   :maxdepth: 2
+
+   transports
+   client
+   qt
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

docs/qt.rst

@@ -0,0 +1,8 @@
+QT GUI Elements for TREZOR applications
+-------------------------
+
+These qt based GUI elements are intended to ease the inclusion of TREZOR specific GUI elemements in your TREZOR application as well as standardize the TREZOR user experience across TREZOR clients.
+
+.. automodule:: trezorlib.qt.pinmatrix
+ :members:
+ :undoc-members:

docs/transport.rst

@@ -0,0 +1,6 @@
+Transport class
+--------------
+
+.. automodule:: trezorlib.transport
+  :members:
+  :undoc-members:

docs/transport_bridge.rst

@@ -0,0 +1,6 @@
+Transport via TREZOR Bridge
+--------------
+
+.. automodule:: trezorlib.transport_bridge
+  :members:
+  :undoc-members:

docs/transport_fake.rst

@@ -0,0 +1,6 @@
+Fake Transport for debugging
+--------------
+
+.. automodule:: trezorlib.transport_fake
+  :members:
+  :undoc-members:

docs/transport_hid.rst

@@ -0,0 +1,15 @@
+Transport via USB HID
+--------------
+
+To get a list of TREZORs that are currently plugged into our computer, we use the enumerate method.
+
+.. code-block:: python
+
+ import trezorlib.transport_hid
+ list_of_trezor_devices = trezorlib.transport_hid.enumerate()
+
+We can now interact with our TREZORs by creating a :doc:`TrezorClient <client>` object.
+
+.. automodule:: trezorlib.transport_hid
+  :members:
+  :undoc-members:

docs/transport_pipe.rst

@@ -0,0 +1,6 @@
+Transport via pipe
+--------------
+
+.. automodule:: trezorlib.transport_pipe
+  :members:
+  :undoc-members:

docs/transport_serial.rst

@@ -0,0 +1,6 @@
+Transport via serial
+--------------
+
+.. automodule:: trezorlib.transport_serial
+  :members:
+  :undoc-members:

docs/transport_socket.rst

@@ -0,0 +1,6 @@
+Transport via socket
+--------------
+
+.. automodule:: trezorlib.transport_socket
+  :members:
+  :undoc-members:

docs/transports.rst

@@ -0,0 +1,22 @@
+Transport methods
+------------------
+
+Transports are ways in which your program can communicate with your TREZOR device.  This can be:
+
+ - direct via US
+ - indirect: through the TREZOR bridge or network
+ - fake: for debugging purposes
+
+Each transport method is represented as an instance of :doc:`the Transport class <transport>`.
+
+The following transport methos are supported:
+
+.. toctree::
+   :maxdepth: 2
+
+   transport_hid
+   transport_bridge
+   transport_fake
+   transport_pipe
+   transport_serial
+   transport_socket